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