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 German translation, provided by Manfred Herrmann.
26 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
28 * Fixed zip and tar file download from CGI under mod_perl. Reported
29 by Pierre Bourgin and Paul Lukins.
31 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
32 Reported by several users.
34 * Added -v option to BackupPC_dump for verbose output (useful when
35 you run the command manually). Added messages for all exits.
37 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
38 now returns the first IP address that matches the subnet mask.
39 Suggested by Tim Demarest.
41 * Fixed BackupPC::View so the top-level directory is handled correctly.
42 This allows the top-level share/directory to be restored via the
43 CGI interface. Reported by several users.
45 * Fixed RsyncFileIO failures on certain large files by replacing seek()
46 with sysseek(). Reported by Manfred Herrmann.
48 * Added configurable highlighting of PC status in the CGI summary
49 screen; submitted by Tim Demarest.
51 * Fixed command queue CGI display; submitted by Tim Demarest.
53 * BackupPC_trashClean now logs an error if it can't remove all the
54 trash and then goes back to sleep, rather than continually trying.
56 * Moved correct user (uid) check into BackupPC::Lib so that all
57 applications do a user check if $Cong{BackupPCUserVerify} is
58 set. The avoids the risk of manually running BackupPC_dump as
61 * Loss of blackout now applies to "host not found" as well as no ping.
62 Reported by Dale Renton.
64 * "Host not found" is now treated in a similar manner to "no ping".
66 * Added suse-linux init.d script from Leon Letto.
68 * Added Gentoo linux init.d script from Tim Demarest.
70 * Applied additional i18n strings from GFK and the translation team.
72 * Fixed option parsing so that getopts errors are reported and we exit.
74 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
76 #------------------------------------------------------------------------
77 # Version 2.0.0beta1, 30 Mar 2003
78 #------------------------------------------------------------------------
80 * Added Spanish translation es.pm from Javier Gonzalez.
82 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
83 when directories were selected in a certain order.
85 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
86 to fix a problem a RedHat8 with perl 5.8.0. It's unclear why this
87 helps, but it should be benign. See:
88 http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
90 #------------------------------------------------------------------------
91 # Version 2.0.0beta0, 23 Feb 2003
92 #------------------------------------------------------------------------
94 * Support for rsync and rsyncd backup and restore. Changes to
95 BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
96 and BackupPC::Xfer::RsyncFileIO.
98 * Added internationalization (i18n) code from Xavier Nicollet,
99 with additions from Guillaume Filion. Voila! BackupPC_Admin
100 now supports English and French, and adding more languages is
101 now easy. New config paramater $Conf{Language} sets the language.
103 * Added optional user-defined pre/post dump/restore commands, allowing
104 things like database shutdown/startup for dumps.
106 * Changed the way hosts are found.
108 * Added $Conf{ClientNameAlias}, which allows the name of the physical
109 client machine to be set. This allows several different backup
110 "hosts" to all refer to the same physical machine, which is
111 convenient if several different types of data need to be backed
112 up, or if different parameters are needed for different parts of
115 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
116 $Conf{NmbLookupCmd} allowing all these commands to be fully
117 configured. Also, all commands can also now be fragments of
120 * Moved all smbclient commands into the config.pl file so the specific
121 arguments can be customized. New config parameters are
122 $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
123 $Conf{SmbClientRestoreCmd}.
125 * Added new BackupPC::View module that creates views of backups
126 (handling merging etc). Updated BackupPC_Admin, BackupPC_zipCreate
127 and BackupPC_tarCreate to use BackupPC::View. This removes lots
128 of merging and mangling code from the higher-level code.
130 * Added code from Toby Johnson that allows additional users to be
131 specified in the hosts file; these users can also view/start/stop
132 and restore backups for that host. Also added a new config
133 setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
134 be listed in the left nav bar for admins.
136 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
137 the maximum number of hardlinks per file in the pool. If a file
138 ever gets to this number of links a new pool file is created to
139 handle additional links.
141 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
142 modules to be loaded.
144 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
145 allow language-specific default messages to be overridden.
147 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
148 files to be represented in the attrib file correctly.
150 * Added support for environment variable BPC_SMB_PASSWD, which is the
151 client's smb password. This overrides the old environment variable
154 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
156 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
157 handle files with trailing spaces.
159 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
160 to ignore multiple signals of the same type.
162 * Added reporting of the largest number of hardlinks in the pool to the
165 * Adding reporting of syntax errors in the per-PC config.pl file.
167 * Updated BackupPC_sendEmail to handle language-specific email messages.
169 * Allow client (host) names to contain spaces. Spaces in host names
170 need to be escaped via "\" in the hosts file. The user of spaces in
171 host names is discouraged, but they should work. One feature that
172 doesn't work with host names that contain spaces is the highlighting
173 of that name in the log file display in the CGI interface. There are
174 no plans to fix this.
176 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
178 * Fixed all open() calls to use 3 argument form to fix handling of file
179 names with trailing whitespace. Also fixed CGI interface so these
180 file names are displayed correctly.
182 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
183 to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
184 Reported by Pascal Schelcher. Fixed similar problem reported by
187 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
188 suggested by Tim Demarest.
190 #------------------------------------------------------------------------
191 # Version 1.5.0, 2 Aug 2002
192 #------------------------------------------------------------------------
194 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
195 option instead of --newer-mtime. Also removed --atime-preserve from
196 $Conf{TarClientCmd}. This makes the default settings work better
199 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
200 so it can correctly warn the user to stop it before upgrading. Reported
203 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
204 Reported by Guillaume Filion.
206 * Added LDAP setup to documentation from David Holland.
208 * Tar.pm now adds a "." to file paths that start with "/", so that all
209 tar paths are relative. From Ludovic Drolez.
211 #------------------------------------------------------------------------
212 # Version 1.5.0beta0, 30 Jun 2002
213 #------------------------------------------------------------------------
215 * A full set of restore options is now supported, including direct
216 restore via smbclient or tar or downloading a zip or tar file.
218 * Major additions to CGI script to support better directory navigation,
219 restore features and mod_perl. Also, file downloads from the CGI
220 interface now correctly preserve the file name and provide the
221 correct Content-Type for the most common types of files. Improved
222 directory navigation was contributed by Ryan Kucera.
224 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
225 zip analog of BackupPC_tarCreate. BackupPC_zipCreate can be used to
226 create a zip archive of any portion of a backup.
228 * Substantial additions to BackupPC_tarCreate to support restore,
229 including modifying path names, handling hardlinks, fixing
230 support of old backups without attributes (pre-v1.4.0). Plus
231 BackupPC_tarCreate is now an offical part of the release.
232 (Lack of support for hardlinks was reported by John Stanley.)
234 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
237 * A unix domain socket is now used for communication between the CGI
238 interface and BackupPC. The original TCP socket is optional. Sockets
239 are correctly re-initialized if config.pl is updated with new socket
242 * For improved security messages over the unix or TCP socket are protected
243 via an MD5 digest based on a shared secret, a sequence number, a time
244 stamp and a unique per-connection number.
246 * Additions to configure.pl to support install of directory navigation
249 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
250 were set to a single string or list (in v1.4.0 only the case of
251 hash worked correctly). Reported by Phillip Bertolus.
253 * Fixed case of $Conf{BackoutGoodCnt} == 0. This setting now makes the
254 client always subject to blackout, matching the comments in config.pl.
255 Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
256 reported by Pascal Schelcher.
258 * Fixed byte and file totals for tar backups, reported by several users.
260 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
261 suggested by Erminio Baranzini.
263 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
264 well as shell escaping of tar arguments.
266 * Fixed entity encoding of 8-bit characters in the CGI interface.
268 * Added optional CGI headers in $Conf{CgiHeaders} that by default
269 is set to a no-cache pragma. Suggested by Benno Zuure.
271 #------------------------------------------------------------------------
272 # Version 1.4.0, 16 Mar 2002
273 #------------------------------------------------------------------------
275 * BackupPC now supports tar (in addition to smb) for extracting host
276 data. This is the most convenient option for linux/unix hosts.
277 Tar can be configured to run over ssh, rsh or to backup a local
278 nfs mount from the host.
280 * Support for special files, including symbolic links, fifo, character
281 and block device files has been added, so that all native linux/unix
282 file types can be correctly backed up when using tar transport.
283 Special files are all stored as regular files and the type attributes
284 are used to remember the original file type.
286 * All unix file attributes are now saved (and pooled when possible).
287 This includes user and group ownership, permissions, and modification
288 time. Smbclient also does a reasonable job of emulating unix
289 permissions (such as mtime), and these attributes get saved too.
291 * The new default is to not fill incremental dumps. configure.pl
292 automatically sets $Conf{IncrFill} to 0. The default was 1
293 (incrementals were filled with hardlinks). Since the CGI
294 script does filling at browsing time, there is no need to
295 fill incremental dumps.
297 * Backup file names are now stored in "mangled" form. Each node of a
298 path is preceded by "f", and special characters (\n, \r, % and /) are
299 URI-encoded as "%xx", where xx is the ascii character's hex value. So
300 c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
301 was done mainly so meta-data could be stored alongside the backup
302 files without name collisions. In particular, the attributes for the
303 files in a directory are stored in a file called "attrib", and
304 mangling avoids file name collisions (I discarded the idea of having
305 a duplicate directory tree for every backup just to store the
306 attributes). Other meta-data (eg: rsync checksums) could be stored in
307 file names preceded by, eg, "c". There are two other benefits to
308 mangling: the share name might contain "/" (eg: "/home/craig" for tar
309 transport), and I wanted that represented as a single level in the
310 storage tree. Secondly, as files are written to NewFileList for later
311 processing by BackupPC_link, embedded newlines in the file's path
312 will cause problems which are avoided by mangling.
314 The CGI script undoes the mangling, so it is invisibe to the user.
315 Of course, old (unmangled) backups are still supported by the CGI
318 * Various changes to the CGI interface, BackupPC_Admin:
320 + Added button that allows users to manually start a full dump in
321 addition to the existing incremental dump.
323 + Added display of file attributes when browsing backups.
325 + Added an optional holdoff time specified by the user when canceling
326 a backup. BackupPC will not attempt any new backups for at least the
327 specified time. This holdoff time can be changed whether or not a
330 + Added supports for file mangling, and correct merging of unfilled
331 backups from mangled or unmangled (and compressed or uncompressed)
332 fulls when browsing or restoring.
334 + Only displays a "Start Incr Backup" button if there are already some
337 + For DHCP hosts, when a user tries to manually start a backup, add
338 a check for the netbios name of both the host the request came
339 from (REMOTE_ADDR) and the last known DHCP address for that host
340 to see if either address matches the host. If not, an error
341 message is display. The previous behavior was that only requests
342 from the client itself succeeded, and requests from other machines
345 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
346 is 1.4.0. The first digit is for major new releases, the middle digit
347 is for significant feature releases and improvements, and the last
348 digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
349 and 1.03 as 1.0.0, ..., 1.3.0.
351 * BackupPC and the CGI script BackupPC_Admin now check that the effective
352 user id is correct to avoid accidentally launching BackupPC as the
353 wrong user or detecting CGI configuration problems. This behavior
354 can be turned off using the $Conf{BackupPCUserVerify} option.
356 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
357 support generic names for both smb and tar transport methods. The
358 CGI script checks for old names for backward compatibility.
360 * Major changed to Backup_dump to support new tar transport. All transport
361 specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
364 * Added workaround for a bug in Samba's smbclient for files between 2GB
365 and 4GB. The file size in the tar header is incorrect. This allows
366 files up to 4GB to work with smbclient, rather than 2GB. To support
367 files larger than 2GB you must make sure perl is compiled with the
368 uselargefiles option (use "perl -V | egrep largefiles" to check) and
369 the pool directory must be on a file system that supports large files.
371 * Moved the pool writing code into a module BackupPC::PoolWrite. This
372 allows the clever file pool checking (digest, uncompressing, comparing
373 etc with minimum disk IO) to be used easily in multiple places (eg: it
374 is now used for writing attribute files so they can be pooled).
376 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
378 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
379 to be happy. The old $Conf{MyPath} contained /usr/local/bin, which
380 on one user's machine was world writable and perl -T correctly
383 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
384 Thanks to Kyle Amon for sending the fix. Decided to move the
385 ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
386 now configure.pl tries to come up with a sensible default based on
389 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
390 share name (eg: C$). Thanks to Jules Agee for this fix. Also
391 changed the default config.pl so that single quotes are used
392 everywhere so that people don't get tripped up putting '$' inside
393 double-quoted strings.
395 #------------------------------------------------------------------------
396 # Version 1.03, 9 Dec 2001
397 #------------------------------------------------------------------------
399 * BackupPC now has full support for compression. There are now two
400 pool areas, the original pool for uncompressed files, and cpool for
401 compressed files. The compression is done by Compress::Zlib.
402 Compression reduces the pool disk usage by around 40%, although your
403 mileage may vary. Compression is optional and can also be specified on
404 a per-PC basis (although this will cost more pool storage since many
405 backup files will have to be stored in both compressed and
408 * A new script, BackupPC_compressPool, can be run to compress the entire
409 pool. This is used once to migrate all the pool data from uncompressed
410 to compressed on existing installations. Read the documentation
411 (Installing BackupPC/Compressing an existing pool) before running
412 BackupPC_compressPool!
414 Alternatively, compression can simply be turned on and all new backups
415 will be compressed. Both old (uncompressed) and new (compressed)
416 backups can be browsed and viewed. Eventually, the old backups will
417 expire and all the pool data will be compressed. However, until the
418 old backups expire, this approach could require 60% or more additional
419 pool storage space to store both uncompressed and compressed versions
422 * Significant improvements to the cgi interface, BackupPC_Admin:
424 - much better layout navigation
425 - handles compressed backup files and compressed log files
426 - handles unfilled incremental dumps
427 - better backup directory browsing navigation
428 - reports compression statistics
429 - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
430 - Additional customization with $Conf{CgiHeaderFontType},
431 $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
432 $Conf{CgiHeaderBgColor}.
434 * Eliminated BackupPC_queueAll. BackupPC directly reads the hosts
435 file and queues the PCs itself. Like config.pl, BackupPC will
436 re-read the hosts file on each wakeup if its modification time
437 changes, or upon a SIGHUP. This also makes for better behavior
438 when adding a host: if you add hosts, simply send a SIGHUP to
439 BackupPC or wait for the next wakeup.
441 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
443 * BackupPC_dump keeps track of compressed file sizes so that compression
444 statistics can be reported by the cgi interface.
446 * Aging of old log files now handles compressed log files (.z extension).
448 * Added configuration option $Conf{IncrFill} to specify whether
449 incremental dumps should be filled in. Old behavior was that
450 filling was on. Now it's optional. See config.pl for more
453 * BackupPC_nightly now cleans and generates statistics for both
454 the uncompressed pool and compressed pool (cpool).
456 * Added new utility script BackupPC_zcat that can be used to
457 uncompresses BackupPC files.
459 * configure.pl offers various options related to compression,
460 depending upon whether this is a new install or upgrade,
461 and whether or not Compress::Zlib is installed.
463 * configure.pl now makes a backup copy of config.pl before
464 config.pl is updated.
466 * added three new fields to the backups file to handle optional
467 filling and compression stats.
469 * Added -e option to BackupPC_dump. BackupPC now invokes BackupPC_dump -e
470 on each dhcp host once each night to verify that very old backups are
471 expired. This ensures that very old backups are expired even if
472 the dhcp host has not been on the network for a long time.
474 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
475 even if compression was off. Thanks to Steve Holmes for reporting
478 * fixed bug that caused a BackupPC queue to get blocked when a backup
479 cancel attempt was made during the BackupPC_link phase.
481 #------------------------------------------------------------------------
482 # Version 1.02, 28 Oct 2001.
483 #------------------------------------------------------------------------
485 * Added new script BackupPC_tarExtract to extract the smbclient tar
486 archive. This reduces disk writes by perhaps 90-95% and disk reads by
487 50%. Previously, tar was used to extract and write everything to disk.
488 Then BackupPC_dump would read enough of each file to compute the MD5
489 digest, and then compare the full file with candidate pool files. So
490 for each 1MB file that matches a single file in the pool, there would
491 be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
493 BackupPC_tarExtract instead extracts the archive using a 1MB memory
494 buffer. This allows the MD5 digest to be computed without touching the
495 disk. Next, any potential pool file compares are done by comparing the
496 pool file against the incoming tar data in memory, which only requires
497 the pool file to be read. So for each 1MB file that matches a single
498 file in the pool, there are now no disk writes, and only 1MB of reads.
499 BackupPC_tarExtract handles arbitrary size files and repeated
500 potential pool matches. If the incoming file doesn't match the pool
501 then it is written to disk (once the pool is mature this happens maybe
504 * Substantial changes to BackupPC_dump:
506 + BackupPC_tarExtract is now used in place of tar.
508 + BackupPC_dump now reads the output from both smbclient and
509 BackupPC_tarExtract and merges them into SmbLOG.
511 + Named pipes are no longer used to connect smbclient to tar
512 (now BackupPC_tarExtract). Regular pipes are used instead.
513 This avoids the need to system mknod or mkfifo.
515 + Locked files on the client that can't be read by smbclient
516 previously were filled with 0x0 bytes by smbclient, meaning
517 tar extracted a useless file filled with 0x0 bytes. Now,
518 BackupPC_dump watches the output of smbclient and removes
519 any files that smbclient couldn't read. This avoids storing
520 useless files. It tries to replace such files with a hard link
521 to a previous dump. These actions appear in the log file.
523 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
524 I/O and is used by BackupPC_tarExtract. BackupPC::FileIO supports
525 reading and writing compressed and regular files and provides all the
526 hooks for compression support in BackupPC (should be supported in next
527 version). BackupPC::FileIO also does efficient writing of files that
528 contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
529 helpful when smbclient reads a locked file, and it fills the tar
530 output with a file of the correct size but all 0x0. Such files will be
531 later removed by BackupPC_dump. But in the meantime, BackupPC::FileIO
532 writes such files efficiently (as sparse files), meaning just a few
533 blocks of disk space will be needed even if the file is large.
535 * alive/dead counting for blackout now works correctly for DHCP hosts.
537 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
538 killed and restarted with backups running.
540 * added extra non blocking select() in BackupPC to make sure the socket
543 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
545 * Updated BackupPC_sendEmail to correctly parse the locked file
546 error from 2.2.1a smbclient, so that missing Outlook file emails
547 can be correctly sent.
549 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
550 hostname read from the hosts file.
552 * BackupPC_Admin provides general summary when the host name is empty.
554 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
556 * configure.pl complains if BackupPC is already running, reminding you
557 to stop it before upgrading.
559 * updated documentation, and fixed auto-insertion of config.pl into
560 BackupPC.pod (previously the last config parameter was left out of
563 #------------------------------------------------------------------------
564 # Version 1.01, 30 Sep 2001
565 #------------------------------------------------------------------------
567 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
569 * BackupPC_sendMail now reads the optional per-PC config file, allowing
570 email configuration parameters to be set on a per-PC basis.
572 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
574 #------------------------------------------------------------------------
575 # Version 1.00, 21 Sep 2001
576 #------------------------------------------------------------------------
578 * Initial release of BackupPC on sourceforge.net.