0120564038925737a03c9c4df18a28f30bca029a
[BackupPC.git] / ChangeLog
1 #========================================================================
2 #
3 # ChangeLog - change log for BackupPC.
4 #
5 # DESCRIPTION
6 #   Revision history for BackupPC, detailing significant changes between
7 #   versions, most recent first.
8 #
9 # AUTHOR
10 #   Craig Barratt  <cbarratt@users.sourceforge.net>
11 #
12 #========================================================================
13 #
14 # Version __VERSION__, released __RELEASEDATE__.
15 #
16 # See http://backuppc.sourceforge.net.
17 #
18 #========================================================================
19
20 #------------------------------------------------------------------------
21 # Version __VERSION__, __RELEASEDATE__
22 #------------------------------------------------------------------------
23
24 * A failed full dump is now saved as a partial (incomplete) dump,
25   provided it includes some files.  This can be used for browsing,
26   restoring etc, and will also form the basis of resuming full
27   dumps.  Only one partial is kept, and it is removed as soon
28   as a successful full (or a new partial) is done.
29
30   (Note: still needs some work to cleanup any partial files when the
31   dump is interrupted or fails).
32
33 * Added support for resuming a full dump for rsync.  The partial
34   full is kept, and to resume an incremental is done against the
35   partial, and a full is done for the rest.
36
37   (Note: not tested!  Also needs a new File::RsyncP that I haven't
38   yet released.)
39
40 * Added support for Rsync checksum caching.  Rsync checksum are
41   appended to the compressed pool files.  This means that block
42   and file checksums do not need to be recomputed on the server
43   when using rsync.
44
45 * Major addition of Archive feature from Josh Marshall.  Special
46   clients can be configured to be archive targets (eg: tape drives,
47   CD-R).  Any subset of the backup clients can be selected and tar
48   archives are created, optionally compressed and split and written
49   to the output device.  Logs are maintained and are browsable.
50
51 * Major changes from Ryan Kucera to add style sheets to the CGI
52   interface, allowing easy customization.  Added new icons and
53   BackupPC logo.  Numerous navigation improvements.
54
55 * Added directory history display to BackupPC_Admin, allowing the
56   user to quickly see which files changed between backups on a
57   per-directory basis.
58
59 * Added exponential expiry option for full dumps.  This allows you
60   to specify
61   
62    - how many fulls to keep at intervals of $Conf{FullPeriod}, followed by
63    - how many fulls to keep at intervals of 2 * $Conf{FullPeriod},
64    - how many fulls to keep at intervals of 4 * $Conf{FullPeriod},
65    - how many fulls to keep at intervals of 8 * $Conf{FullPeriod},
66    - how many fulls to keep at intervals of 16 * $Conf{FullPeriod},
67
68   and so on.  This allows you, for example, to keep 4 weekly fulls,
69   followed by 6 fulls every 4 weeks (approx 1 month) and 2 fulls at
70   16 weeks, for roughly 1 year of history.  This works by deleting
71   every other full as each expiry boundary is crossed.  Suggested
72   by David Cramblett.
73
74 * Added Italian language translation it.pm from Lorenzo Cappelletti.
75
76 * Major updates to language files for new features and tags changes.
77   Updated makeDist to do pedantic consistency checking of language
78   files.
79
80 * Addition of administration options from Paul Lukins.  Initial
81   page allows server to be started/stopped/reloaded.
82
83 * Split BackupPC_Admin into a set of modules, one for each major action.
84   Each action is now a seperate module in lib/BackupPC/CGI.
85
86 * Allow the blackout period begin/end to span midnight.  Adapted
87   from patch submitted by David Smith.
88
89 * Allow multiple blackout periods, with new config variable
90   $Conf{BlackoutPeriods} that replaces the old variables
91   $Conf{BlackoutHourBegin}, $Conf{BlackoutHourEnd}, and
92   $Conf{BlackoutWeekDays}.  Based on patch submitted by
93   Lorenzo Cappelletti.
94
95 * Disabled alarms after forks to avoid timeouts in children that
96   do not reset their alarm.  Prompted by ideas from James Leu.
97
98 * Added options for block size, buffer size and share wild-card to
99   BackupPC_tarCreate.  Also added negative backup number options
100   that are relative to the last (so -1 is the last), suggested by
101   William McKee and Carl Soderstrom.
102
103 * Add creation of per-PC directory in BackupPC/CGI/Restore.pm in
104   case it doesn't already exist.
105
106 * Added -q -x to all ssh commands in conf/config.pl.  Suggested by
107   SI Reasoning and Niranjan Ghate.
108
109 * Changed restore code so that option #1 (direct restore) can be
110   disabled if the restore command is undefined.  Disabling direct
111   restore is necessary if the share is read-only.  Suggested by
112   Rich B from SAIC.
113
114 * Changed regexp in lib/BackupPC/Smb.pm to allow numbers with both
115   a decimal point or comma for international versions of Samba.
116   Patch submitted by Frank Gard.
117
118 * Browsing and directory history now sort the files in a
119   case-insensitive manner.
120
121 * Changed exec() syntax to allow executing commands whose path
122   contains spaces.
123
124 * Swapped the Server and Hosts sections on the Nav bar.  Moved the
125   host search text box to the top of the hosts section.  This was
126   done to move the variable-length part of the Nav bar (when all
127   hosts are displayed) to the bottom.
128
129 * Fixed a bug in tar restore related to how the common prefix path is
130   removed.  Now ensure that the common path is at a directory boundary.
131   Reported by Patrick Neuner.
132
133 * Added --chuid ${USER} to init.d/src/gentoo-backuppc.  Suggested by
134   SI Reasoning, Pascal Pochol, Michael Evanoff and others.
135
136 * Added Suse notes to init.d/README from Bruno Vernay.
137
138 * Added Apache 2 documentation fix from Michael Tuzi.
139
140 #------------------------------------------------------------------------
141 # Version 2.0.2, 6 Oct 2003
142 #------------------------------------------------------------------------
143
144 * Fixed stupid last-minute change in octal size conversion in
145   Backup_tarExtract.
146
147 #-----------------------------------------------------------------------
148 # Version 2.0.1, 5 Oct 2003
149 #------------------------------------------------------------------------
150
151 * Fixed handling of >= 8GB files in BackupPC_tarExtract and >= 4GB
152   files in BackupPC_tarCreate.
153
154 * Removed smbclient size repair in BackupPC_tarExtract for files
155   between 2GB and 4GB.  This means that BackupPC_tarExtract 2.0.1
156   doesn't behave the same as 2.0.0 for file sizes between 2GB and 4GB
157   extacted using smbclient 2.2.x.  If you have problems backing up
158   files whose size is between 2GB and 4GB using smbclient 2.2.x
159   you should upgrade smbclient to 3.0, since it now generates
160   correct file sizes.
161
162 * Replace PingClientPath with PingPath in configure.pl.
163
164 * Removed -T (taint mode) on binaries installed in configure.pl.
165
166 * Added support for smbclient from samba version 3.0.0.
167
168 * Fixed $Conf{HardLinkMax} limit check in BackupPC::Lib; reported
169   by Ross Skaliotis.
170
171 * In BackupPC_Admin, default REMOTE_USER to $Conf{BackupPCUser}
172   if it is not defined.  This allows the CGI interface to work
173   when AdminUsers = '*'.  Reported by Quentin Arce.
174
175 * For SMB, code that detected files with a read-locked region (eg:
176   outlook .pst files), removed them and then tried to link with an
177   earlier version was broken.  This code missed a step of mangling
178   the file names.  This is now fixed.  Reported by Pierre Bourgin.
179
180 * A backup of a share that has zero files is now considered
181   fatal. This is used to catch miscellaneous Xfer errors that
182   result in no files being backed up.  A new config parameter
183   $Conf{BackupZeroFilesIsFatal} (defaults to 1) and can be set to
184   zero to turn off this check.  Suggested by Guillaume Filion.
185   Additional change: this check only applies to a full dump.
186
187 * SMB: now detect NT_STATUS_ACCESS_DENIED on entire share or BackupFilesOnly
188   (also ERRDOS - ERRnoaccess (Access denied.) for older versions of
189   smbclient.)  Suggested by Guillaume Filion.
190
191 * SMB: now detects "tree connect failed: NT_STATUS_BAD_NETWORK_NAME" and
192   the dump is considered failed.
193
194 * Rsync: Previously BackupFilesOnly = '/' did --include '/' --exclude '/*',
195   which just included the '/' directory and nothing below.  Now it
196   does just --include '/', which should include everything.
197   Reported by denon.
198
199 * Add hostError to DumpPostUserCmd variable substitutions for both dump
200   and restore.
201
202 * Verbose output in Lib.pm goes to STDERR, not STDOUT.  This now
203   makes BackupPC_dump -v work better.
204
205 * Don't allow browsing with ".." in directory in case a user tries
206   to trick BackupPC_Admin into displaying directories outside where
207   they are allowed.
208
209 * Required File::RsyncP version is now 0.44, since File::RsyncP 0.44
210   fixes large file (>2GB) bugs.  Large file bugs reported by Steve
211   Waltner.
212
213 #------------------------------------------------------------------------
214 # Version 2.0.0, 14 Jun 2003
215 #------------------------------------------------------------------------
216
217 * Minor tweaks to disable utf8 on utf8-capable machines (eg: RH8+).
218   Added "no utf8" to all programs, and added binmode() to relevant
219   file handles.
220
221 #------------------------------------------------------------------------
222 # Version 2.0.0beta3, 1 Jun 2003
223 #------------------------------------------------------------------------
224
225 * Several improvements to restore: cancel now reports the correct
226   message and cleans up correctly.
227
228 * Rsync with whitespace and wildcard excludes fixed by replacing
229   argList with argList+ in config.pl plus a fix to Lib.pm for
230   shell escaping array arguments.
231
232 * Fixed rsync restore for character and block special devices
233   (major and minor device numbers weren't correctly restored).
234
235 * Fixed typo in bin/BackupPC_restore (XferLOG -> RestoreLOG).
236
237 * (Re)-fixed "Bad command" in log file when restore via tar or zip
238   file download is done.
239
240 * Added untaint to exec in Lib.pm to avoid tainted errors.
241
242 * Applied additional tweak to hilight patch from Tim Demarest.
243
244 * $Conf{CgiAdminUsers} = '*' now allows privileged even with REMOTE_USER
245   not set.
246
247 * Don't display RsyncdPasswd when displaying config.pl files.
248
249 * Replace pipe with socketpair in bin/BackupPC_dump and bin/BackupPC_restore,
250   which increases typical buffering from 4K to 16K-64K.  This improves the
251   performance.
252
253 * Add check on $ENV{LANG} setting do configure.pl: if LANG includes utf
254   then a warning is printed.
255
256 #------------------------------------------------------------------------
257 # Version 2.0.0beta2, 11 May 2003
258 #------------------------------------------------------------------------
259
260 * Added German translation, provided by Manfred Herrmann.
261
262 * Fixed large-file problem with rsync, reported by Manfred Herrmann.
263
264 * Fixed zip and tar file download from CGI under mod_perl.  Reported
265   by Pierre Bourgin and Paul Lukins.
266
267 * Fixed directory browsing and top-level directory browsing in 2.0.0beta0.
268   Reported by several users.
269
270 * Added -v option to BackupPC_dump for verbose output (useful when
271   you run the command manually).  Added messages for all exits.
272
273 * If nmblookup returns multiple IP addresses, NetBiosHostIPFind()
274   now returns the first IP address that matches the subnet mask.
275   Suggested by Tim Demarest.
276
277 * Fixed BackupPC::View so the top-level directory is handled correctly.
278   This allows the top-level share/directory to be restored via the
279   CGI interface.  Reported by several users.
280
281 * Fixed RsyncFileIO failures on certain large files by replacing seek()
282   with sysseek().  Reported by Manfred Herrmann.
283
284 * Added configurable highlighting of PC status in the CGI summary
285   screen; submitted by Tim Demarest.
286
287 * Fixed command queue CGI display; submitted by Tim Demarest.
288
289 * BackupPC_trashClean now logs an error if it can't remove all the
290   trash and then goes back to sleep, rather than continually trying.
291
292 * Moved correct user (uid) check into BackupPC::Lib so that all
293   applications do a user check if $Cong{BackupPCUserVerify} is
294   set.  The avoids the risk of manually running BackupPC_dump as
295   the wrong user.
296
297 * Loss of blackout now applies to "host not found" as well as no ping.
298   Reported by Dale Renton.
299
300 * "Host not found" is now treated in a similar manner to "no ping".
301
302 * Added suse-linux init.d script from Leon Letto.
303
304 * Added Gentoo linux init.d script from Tim Demarest.
305
306 * Applied additional i18n strings from GFK and the translation team.
307
308 * Fixed option parsing so that getopts errors are reported and we exit.
309
310 * Changed reporting of Xfer PIDs so that rsync cancel works correctly.
311
312 #------------------------------------------------------------------------
313 # Version 2.0.0beta1, 30 Mar 2003
314 #------------------------------------------------------------------------
315
316 * Added Spanish translation es.pm from Javier Gonzalez.
317
318 * Fixed CGI browse navigation bug that causes BackupPC_Admin to wedge
319   when directories were selected in a certain order.
320
321 * Fixed BackupPC::PoolWrite so that it can recover when the initial
322   file size is wrong.  This is needed since rsync could write a file
323   whose size is different from the initial size returned in the
324   file list when that file is updated while rsync is running.
325
326 * Added binmode(STDIN) to BackupPC_tarExtract, suggested by Pat LoPresti
327   to fix a problem a RedHat8 with perl 5.8.0.  It's unclear why this
328   helps, but it should be benign.  See:
329     http://sourceforge.net/mailarchive/forum.php?thread_id=1853018&forum_id=503
330
331 #------------------------------------------------------------------------
332 # Version 2.0.0beta0, 23 Feb 2003
333 #------------------------------------------------------------------------
334
335 * Support for rsync and rsyncd backup and restore.  Changes to
336   BackupPC_dump, BackupPC_restore, and new modules BackupPC::Xfer::Rsync
337   and BackupPC::Xfer::RsyncFileIO.
338
339 * Added internationalization (i18n) code from Xavier Nicollet,
340   with additions from Guillaume Filion.  Voila!  BackupPC_Admin
341   now supports English and French, and adding more languages is
342   now easy.  New config paramater $Conf{Language} sets the language.
343
344 * Added optional user-defined pre/post dump/restore commands, allowing
345   things like database shutdown/startup for dumps.
346
347 * Changed the way hosts are found.
348
349 * Added $Conf{ClientNameAlias}, which allows the name of the physical
350   client machine to be set.  This allows several different backup
351   "hosts" to all refer to the same physical machine, which is
352   convenient if several different types of data need to be backed
353   up, or if different parameters are needed for different parts of
354   the host.
355
356 * Replaced $Conf{PingArgs} with $Conf{PingCmd}, added $Conf{DfCmd},
357   $Conf{NmbLookupCmd} allowing all these commands to be fully
358   configured.  Also, all commands can also now be fragments of
359   perl code.
360
361 * Moved all smbclient commands into the config.pl file so the specific
362   arguments can be customized.  New config parameters are
363   $Conf{SmbClientFullCmd}, $Conf{SmbClientIncrCmd} and
364   $Conf{SmbClientRestoreCmd}.
365
366 * Added new BackupPC::View module that creates views of backups
367   (handling merging etc).  Updated BackupPC_Admin, BackupPC_zipCreate
368   and BackupPC_tarCreate to use BackupPC::View.  This removes lots
369   of merging and mangling code from the higher-level code.
370
371 * Added code from Toby Johnson that allows additional users to be
372   specified in the hosts file; these users can also view/start/stop
373   and restore backups for that host.  Also added a new config
374   setting $Conf{CgiNavBarAdminAllHosts} that allows all hosts to
375   be listed in the left nav bar for admins.
376
377 * Added $Conf{HardLinkMax} (default 31999) which sets the limit on
378   the maximum number of hardlinks per file in the pool.  If a file
379   ever gets to this number of links a new pool file is created to
380   handle additional links.
381
382 * Added $Conf{PerlModuleLoad}, which allows optional additional perl
383   modules to be loaded.
384
385 * Added $Conf{EMailUserDestDomain} and other EMail config settings to
386   allow language-specific default messages to be overridden.
387
388 * Added BPC_FTYPE_DELETED to lib/BackupPC/Attrib.pm, allowing deleted
389   files to be represented in the attrib file correctly.
390
391 * Added support for environment variable BPC_SMB_PASSWD, which is the
392   client's smb password.  This overrides the old environment variable
393   PASSWD.
394
395 * Added taint cleanup for perl5.8 to lib/BackupPC/Lib.pm.
396
397 * Changed $tar_unpack_header format in BackupPC_tarExtract to correctly
398   handle files with trailing spaces.
399
400 * Added catching of SIG_PIPE to BackupPC_dump, and changed catch_signal
401   to ignore multiple signals of the same type.
402
403 * Added reporting of the largest number of hardlinks in the pool to the
404   log file.
405
406 * Adding reporting of syntax errors in the per-PC config.pl file.
407
408 * Updated BackupPC_sendEmail to handle language-specific email messages.
409
410 * Allow client (host) names to contain spaces.  Spaces in host names
411   need to be escaped via "\" in the hosts file.  The user of spaces in
412   host names is discouraged, but they should work.  One feature that
413   doesn't work with host names that contain spaces is the highlighting
414   of that name in the log file display in the CGI interface.  There are
415   no plans to fix this.
416
417 * Renamed $Conf{SmbClientTimeout} to $Conf{ClientTimeout}.
418
419 * Fixed all open() calls to use 3 argument form to fix handling of file
420   names with trailing whitespace.  Also fixed CGI interface so these
421   file names are displayed correctly.
422
423 * Fixed new 2.0.0 CGI navigation bug that causes the top-level directory
424   to have a URL "&share=//boot&dir=" instead of "&share=/boot&dir=/".
425   Reported by Pascal Schelcher.  Fixed similar problem reported by
426   Doug Lytle.
427
428 * Added "PerlTaintCheck On" to the mod_perl section in the docs,
429   suggested by Tim Demarest.
430
431 #------------------------------------------------------------------------
432 # Version 1.5.0, 2 Aug 2002
433 #------------------------------------------------------------------------
434
435 * Changed conf/config.pl so that $Conf{TarIncrArgs} uses the --newer
436   option instead of --newer-mtime.  Also removed --atime-preserve from
437   $Conf{TarClientCmd}.  This makes the default settings work better
438   with tripwire.
439
440 * Fixed configure.pl so it correctly detects a running BackupPC <= v1.4.0
441   so it can correctly warn the user to stop it before upgrading.  Reported
442   by David Holland.
443
444 * Added missing ";" to entity escape in EscapeHTML in BackupPC_Admin.
445   Reported by Guillaume Filion.
446
447 * Added LDAP setup to documentation from David Holland.
448
449 * Tar.pm now adds a "." to file paths that start with "/", so that all
450   tar paths are relative.  From Ludovic Drolez.
451
452 #------------------------------------------------------------------------
453 # Version 1.5.0beta0, 30 Jun 2002
454 #------------------------------------------------------------------------
455
456 * A full set of restore options is now supported, including direct
457   restore via smbclient or tar or downloading a zip or tar file.
458
459 * Major additions to CGI script to support better directory navigation,
460   restore features and mod_perl.  Also, file downloads from the CGI
461   interface now correctly preserve the file name and provide the
462   correct Content-Type for the most common types of files.  Improved
463   directory navigation was contributed by Ryan Kucera.
464
465 * New script BackupPC_zipCreate (contributed by Guillaume Filion) is the
466   zip analog of BackupPC_tarCreate.  BackupPC_zipCreate can be used to
467   create a zip archive of any portion of a backup.
468
469 * Substantial additions to BackupPC_tarCreate to support restore,
470   including modifying path names, handling hardlinks, fixing
471   support of old backups without attributes (pre-v1.4.0).  Plus
472   BackupPC_tarCreate is now an offical part of the release.
473   (Lack of support for hardlinks was reported by John Stanley.)
474
475 * BackupPC_tarExtract now supports hardlinks and fixed pooling of
476   attribute files.
477
478 * A unix domain socket is now used for communication between the CGI
479   interface and BackupPC.  The original TCP socket is optional.  Sockets
480   are correctly re-initialized if config.pl is updated with new socket
481   settings.
482
483 * For improved security messages over the unix or TCP socket are protected
484   via an MD5 digest based on a shared secret, a sequence number, a time
485   stamp and a unique per-connection number.
486
487 * Additions to configure.pl to support install of directory navigation
488   images.
489
490 * Fixed case where $Conf{BackupFilesOnly} or $Conf{BackupFilesExclude}
491   were set to a single string or list (in v1.4.0 only the case of
492   hash worked correctly).  Reported by Phillip Bertolus.
493
494 * Fixed case of $Conf{BackoutGoodCnt} == 0.  This setting now makes the
495   client always subject to blackout, matching the comments in config.pl.
496   Also fixed handling of $Conf{BackoutGoodCnt} < 0 in the CGI script
497   reported by Pascal Schelcher.
498
499 * Fixed byte and file totals for tar backups, reported by several users.
500
501 * Fixed --newer-mtime date/timestamp format to make it ISO 8601 compliant,
502   suggested by Erminio Baranzini.
503
504 * Fixed handling of $Conf{BackupFilesOnly} in BackupPC::Xfer::Tar.pm, as
505   well as shell escaping of tar arguments.
506
507 * Fixed entity encoding of 8-bit characters in the CGI interface.
508
509 * Added optional CGI headers in $Conf{CgiHeaders} that by default
510   is set to a no-cache pragma.  Suggested by Benno Zuure.
511
512 #------------------------------------------------------------------------
513 # Version 1.4.0, 16 Mar 2002
514 #------------------------------------------------------------------------
515
516 * BackupPC now supports tar (in addition to smb) for extracting host    
517   data.  This is the most convenient option for linux/unix hosts.
518   Tar can be configured to run over ssh, rsh or to backup a local
519   nfs mount from the host.
520
521 * Support for special files, including symbolic links, fifo, character
522   and block device files has been added, so that all native linux/unix
523   file types can be correctly backed up when using tar transport.
524   Special files are all stored as regular files and the type attributes
525   are used to remember the original file type.
526
527 * All unix file attributes are now saved (and pooled when possible).
528   This includes user and group ownership, permissions, and modification
529   time.  Smbclient also does a reasonable job of emulating unix 
530   permissions (such as mtime), and these attributes get saved too.
531
532 * The new default is to not fill incremental dumps.  configure.pl
533   automatically sets $Conf{IncrFill} to 0.  The default was 1
534   (incrementals were filled with hardlinks).  Since the CGI
535   script does filling at browsing time, there is no need to
536   fill incremental dumps.
537
538 * Backup file names are now stored in "mangled" form. Each node of a
539   path is preceded by "f", and special characters (\n, \r, % and /) are
540   URI-encoded as "%xx", where xx is the ascii character's hex value. So
541   c:/craig/example.txt is now stored as fc/fcraig/fexample.txt. This
542   was done mainly so meta-data could be stored alongside the backup
543   files without name collisions.  In particular, the attributes for the
544   files in a directory are stored in a file called "attrib", and
545   mangling avoids file name collisions (I discarded the idea of having
546   a duplicate directory tree for every backup just to store the
547   attributes). Other meta-data (eg: rsync checksums) could be stored in
548   file names preceded by, eg, "c".  There are two other benefits to
549   mangling: the share name might contain "/" (eg: "/home/craig" for tar
550   transport), and I wanted that represented as a single level in the
551   storage tree.  Secondly, as files are written to NewFileList for later
552   processing by BackupPC_link, embedded newlines in the file's path
553   will cause problems which are avoided by mangling.
554
555   The CGI script undoes the mangling, so it is invisibe to the user.
556   Of course, old (unmangled) backups are still supported by the CGI
557   interface.
558
559 * Various changes to the CGI interface, BackupPC_Admin:
560
561   + Added button that allows users to manually start a full dump in
562     addition to the existing incremental dump.
563
564   + Added display of file attributes when browsing backups.
565
566   + Added an optional holdoff time specified by the user when canceling
567     a backup. BackupPC will not attempt any new backups for at least the
568     specified time. This holdoff time can be changed whether or not a
569     backup is running.
570
571   + Added supports for file mangling, and correct merging of unfilled
572     backups from mangled or unmangled (and compressed or uncompressed)
573     fulls when browsing or restoring.
574
575   + Only displays a "Start Incr Backup" button if there are already some
576     backups.
577
578   + For DHCP hosts, when a user tries to manually start a backup, add
579     a check for the netbios name of both the host the request came
580     from (REMOTE_ADDR) and the last known DHCP address for that host
581     to see if either address matches the host. If not, an error
582     message is display. The previous behavior was that only requests
583     from the client itself succeeded, and requests from other machines
584     quietly failed.
585
586 * Changed the version numbering to X.Y.Z, instead of X.0Y. This release
587   is 1.4.0. The first digit is for major new releases, the middle digit
588   is for significant feature releases and improvements, and the last
589   digit is for bug fixes. You should think of the old 1.00, 1.01, 1.02
590   and 1.03 as 1.0.0, ..., 1.3.0.
591
592 * BackupPC and the CGI script BackupPC_Admin now check that the effective
593   user id is correct to avoid accidentally launching BackupPC as the
594   wrong user or detecting CGI configuration problems.  This behavior
595   can be turned off using the $Conf{BackupPCUserVerify} option.
596
597 * In numerous places changed "Smb" to "Xfer" (eg: log file names) to
598   support generic names for both smb and tar transport methods.  The
599   CGI script checks for old names for backward compatibility.
600
601 * Major changed to Backup_dump to support new tar transport.  All transport
602   specific code moved into BackupPC::Xfer::Smb and BackupPC::Xfer::Tar
603   objects.
604
605 * Added workaround for a bug in Samba's smbclient for files between 2GB
606   and 4GB.  The file size in the tar header is incorrect.  This allows
607   files up to 4GB to work with smbclient, rather than 2GB.  To support
608   files larger than 2GB you must make sure perl is compiled with the
609   uselargefiles option (use "perl -V | egrep largefiles" to check) and
610   the pool directory must be on a file system that supports large files.
611
612 * Moved the pool writing code into a module BackupPC::PoolWrite.  This
613   allows the clever file pool checking (digest, uncompressing, comparing
614   etc with minimum disk IO) to be used easily in multiple places (eg: it
615   is now used for writing attribute files so they can be pooled).
616
617 * Changed MD5 to Digest::MD5 to avoid use of the depreceated MD5 module.
618
619 * Shortened default $Conf{MyPath} so that perl's taint mode is more likely
620   to be happy.  The old $Conf{MyPath} contained /usr/local/bin, which
621   on one user's machine was world writable and perl -T correctly
622   complained about it.
623
624 * Fixed ping command options in Lib.pm so that it works on OpenBSD.
625   Thanks to Kyle Amon for sending the fix.  Decided to move the
626   ping options from Lib.pm into config.pl (as $Conf{PingArgs}) and
627   now configure.pl tries to come up with a sensible default based on
628   the OS.
629
630 * Fixed argument checking in BackupPC_tarExtract to allow '$' in the
631   share name (eg: C$).  Thanks to Jules Agee for this fix.  Also
632   changed the default config.pl so that single quotes are used
633   everywhere so that people don't get tripped up putting '$' inside
634   double-quoted strings.
635
636 #------------------------------------------------------------------------
637 # Version 1.03, 9 Dec 2001
638 #------------------------------------------------------------------------
639
640 * BackupPC now has full support for compression.  There are now two
641   pool areas, the original pool for uncompressed files, and cpool for
642   compressed files. The compression is done by Compress::Zlib.
643   Compression reduces the pool disk usage by around 40%, although your
644   mileage may vary.  Compression is optional and can also be specified on
645   a per-PC basis (although this will cost more pool storage since many
646   backup files will have to be stored in both compressed and
647   uncompressed forms.
648
649 * A new script, BackupPC_compressPool, can be run to compress the entire
650   pool.  This is used once to migrate all the pool data from uncompressed
651   to compressed on existing installations.  Read the documentation
652   (Installing BackupPC/Compressing an existing pool) before running
653   BackupPC_compressPool!
654
655   Alternatively, compression can simply be turned on and all new backups
656   will be compressed. Both old (uncompressed) and new (compressed)
657   backups can be browsed and viewed. Eventually, the old backups will
658   expire and all the pool data will be compressed.  However, until the
659   old backups expire, this approach could require 60% or more additional
660   pool storage space to store both uncompressed and compressed versions
661   of the backup files.
662
663 * Significant improvements to the cgi interface, BackupPC_Admin:
664
665     - much better layout navigation
666     - handles compressed backup files and compressed log files
667     - handles unfilled incremental dumps
668     - better backup directory browsing navigation
669     - reports compression statistics
670     - $Conf{CgiDateFormatMMDD} allows you to set date format (MM/DD or DD/MM)
671     - Additional customization with $Conf{CgiHeaderFontType},
672       $Conf{CgiHeaderFontSize}, $Conf{CgiNavBarBgColor}, and
673       $Conf{CgiHeaderBgColor}.
674
675 * Eliminated BackupPC_queueAll.  BackupPC directly reads the hosts
676   file and queues the PCs itself.  Like config.pl, BackupPC will
677   re-read the hosts file on each wakeup if its modification time
678   changes, or upon a SIGHUP.  This also makes for better behavior
679   when adding a host: if you add hosts, simply send a SIGHUP to
680   BackupPC or wait for the next wakeup.
681
682 * BackupPC_dump now compresses the SmbLOG file if compression is enabled.
683
684 * BackupPC_dump keeps track of compressed file sizes so that compression
685   statistics can be reported by the cgi interface.
686
687 * Aging of old log files now handles compressed log files (.z extension).
688
689 * Added configuration option $Conf{IncrFill} to specify whether
690   incremental dumps should be filled in.  Old behavior was that
691   filling was on.  Now it's optional.  See config.pl for more
692   details.
693
694 * BackupPC_nightly now cleans and generates statistics for both
695   the uncompressed pool and compressed pool (cpool).
696
697 * Added new utility script BackupPC_zcat that can be used to
698   uncompresses BackupPC files.
699
700 * configure.pl offers various options related to compression,
701   depending upon whether this is a new install or upgrade,
702   and whether or not Compress::Zlib is installed.
703
704 * configure.pl now makes a backup copy of config.pl before
705   config.pl is updated.
706
707 * added three new fields to the backups file to handle optional
708   filling and compression stats.
709
710 * Added -e option to BackupPC_dump.  BackupPC now invokes BackupPC_dump -e
711   on each dhcp host once each night to verify that very old backups are
712   expired.  This ensures that very old backups are expired even if
713   the dhcp host has not been on the network for a long time.
714
715 * fixed bug in BackupPC::FileZIO.pm that required Compress::Zlib,
716   even if compression was off.  Thanks to Steve Holmes for reporting
717   this.
718
719 * fixed bug that caused a BackupPC queue to get blocked when a backup
720   cancel attempt was made during the BackupPC_link phase.
721
722 #------------------------------------------------------------------------
723 # Version 1.02, 28 Oct 2001.
724 #------------------------------------------------------------------------
725
726 * Added new script BackupPC_tarExtract to extract the smbclient tar
727   archive. This reduces disk writes by perhaps 90-95% and disk reads by
728   50%. Previously, tar was used to extract and write everything to disk.
729   Then BackupPC_dump would read enough of each file to compute the MD5
730   digest, and then compare the full file with candidate pool files.  So
731   for each 1MB file that matches a single file in the pool, there would
732   be 1MB of disk writes and 2MB of disk reads (to compare two 1MB files).
733
734   BackupPC_tarExtract instead extracts the archive using a 1MB memory
735   buffer.  This allows the MD5 digest to be computed without touching the
736   disk.  Next, any potential pool file compares are done by comparing the
737   pool file against the incoming tar data in memory, which only requires
738   the pool file to be read.  So for each 1MB file that matches a single
739   file in the pool, there are now no disk writes, and only 1MB of reads.
740   BackupPC_tarExtract handles arbitrary size files and repeated
741   potential pool matches.  If the incoming file doesn't match the pool
742   then it is written to disk (once the pool is mature this happens maybe
743   5-10% of the time).
744
745 * Substantial changes to BackupPC_dump:
746
747     + BackupPC_tarExtract is now used in place of tar.
748
749     + BackupPC_dump now reads the output from both smbclient and
750       BackupPC_tarExtract and merges them into SmbLOG.
751
752     + Named pipes are no longer used to connect smbclient to tar
753       (now BackupPC_tarExtract).  Regular pipes are used instead.
754       This avoids the need to system mknod or mkfifo.
755
756     + Locked files on the client that can't be read by smbclient
757       previously were filled with 0x0 bytes by smbclient, meaning
758       tar extracted a useless file filled with 0x0 bytes.  Now,
759       BackupPC_dump watches the output of smbclient and removes
760       any files that smbclient couldn't read.  This avoids storing
761       useless files.  It tries to replace such files with a hard link
762       to a previous dump.  These actions appear in the log file.
763
764 * added new module lib/BackupPC/FileZIO.pm. This handles pool file
765   I/O and is used by BackupPC_tarExtract.  BackupPC::FileIO supports
766   reading and writing compressed and regular files and provides all the
767   hooks for compression support in BackupPC (should be supported in next
768   version). BackupPC::FileIO also does efficient writing of files that
769   contain leading 0x0 bytes (by seeking past the 0x0 bytes). This is
770   helpful when smbclient reads a locked file, and it fills the tar
771   output with a file of the correct size but all 0x0.  Such files will be
772   later removed by BackupPC_dump.  But in the meantime, BackupPC::FileIO
773   writes such files efficiently (as sparse files), meaning just a few
774   blocks of disk space will be needed even if the file is large.
775
776 * alive/dead counting for blackout now works correctly for DHCP hosts.
777
778 * BackupPC resets activeJob on startup, to fix bug when BackupPC was
779   killed and restarted with backups running.
780
781 * added extra non blocking select() in BackupPC to make sure the socket
782   reads don't block.
783
784 * BackupPC avoids queuing multiple BackupPC_queueAll's on the CmdQueue.
785
786 * Updated BackupPC_sendEmail to correctly parse the locked file
787   error from 2.2.1a smbclient, so that missing Outlook file emails
788   can be correctly sent.
789
790 * Changed HostInfoRead() in lib/BackupPC/Lib.pm to lowercase the
791   hostname read from the hosts file.
792
793 * BackupPC_Admin provides general summary when the host name is empty.
794
795 * configure.pl (and BackupPC) now requires perl 5.6.0 or later.
796
797 * configure.pl complains if BackupPC is already running, reminding you
798   to stop it before upgrading.
799
800 * updated documentation, and fixed auto-insertion of config.pl into
801   BackupPC.pod (previously the last config parameter was left out of
802   BackupPC.pod).
803
804 #------------------------------------------------------------------------
805 # Version 1.01, 30 Sep 2001
806 #------------------------------------------------------------------------
807
808 * Documentation cleanup in README, doc/BackupPC.pod, conf/config.pl.
809
810 * BackupPC_sendMail now reads the optional per-PC config file, allowing
811   email configuration parameters to be set on a per-PC basis.
812
813 * Removed the unused 4096-length MD5 digest code in lib/BackupPC/Lib.pm.
814
815 #------------------------------------------------------------------------
816 # Version 1.00, 21 Sep 2001
817 #------------------------------------------------------------------------
818
819 * Initial release of BackupPC on sourceforge.net.