]> git.sur5r.net Git - bacula/bacula/blob - bacula/kernstodo
Rework spec files, add DESTDIR, fix spelling of autochanger
[bacula/bacula] / bacula / kernstodo
1                  Kern's ToDo List
2                   28 April 2003 
3
4 Documentation to do: (any release a little bit at a time)
5 - Document running a test version.
6 - Document query file format.
7 - Document static linking
8 - Document problems with Verify and pruning.
9 - Document how to use multiple databases.
10 - Add a section to the doc on Manual cycling of Volumes.
11
12           
13 Testing to do: (painful)
14 - that ALL console command line options work and are always implemented
15 - blocksize recognition code.
16 - multiple simultaneous Volumes
17
18 - Figure out how to use ssh or stunnel to protect Bacula communications.
19
20
21 For 1.31 release:
22 - Fix "access not allowed" for backup of files on WinXP.
23 - Check for existence of all new Win32 API's.  See LoadLibrary in 
24   winservice.cpp
25 - Add Progress command that periodically reports the progress of
26   a job or all jobs.
27 - Fix problem reported by Christopher McCurdy <cmccurdy@eecis.udel.edu>
28    xeon-fd:      Could not stat c:/Documents and Settings/All 
29    Users/Application Data/Humc:\Documents and Settings\All User98_AIX.kbf: 
30    ERR=No such file or directory
31 - Implement argv/argk in place of sscanf in the daemon protocol.
32 - Examine Bare Metal restore problem.
33 - Test multiple simultaneous Volumes
34 - Document FInclude ...
35 - Test and implement get_pint and get_yesno.
36 - Implement timeout in response() when it should come quickly.
37 - Check if Job/File retentions apply to multivolume jobs.
38 - Remove subsysdir from conf files (used only in autostart scripts).
39 - Implement console @echo command.
40 - Implement global with DB name and add to btraceback.gdb
41 - Bug: fix access problems on files restored on WinXP.
42 - Implement a Slot priority (loaded/not loaded).
43 - Implement "vacation" Incremental only saves.
44 - Implement single pane restore (much like the Gftp panes).
45 - Implement Automatic Mount even in operator wait.
46 - Implement create "FileSet"?
47 - Implement Release Device in the Job resource to unmount a drive.
48 - Implement Acquire Device in the Job resource to mount a drive,
49   be sure this works with admin jobs so that the user can get
50   prompted to insert the correct tape.  Possibly some way to say to
51   run the job but don't save the files.
52 - Implement all command line args on run.
53 - Implement command line "restore" args.
54 - Implement "restore current select=no"
55 - Fix watchdog pthread crash on Win32 (this is pthread_kill() Cygwin bug)
56 - Implement "scratch pool" where tapes are defined and can be
57   taken by any pool that needs them.
58 - Implement restore "current system", but take all files without
59   doing selection tree -- so that jobs without File records can
60   be restored.
61 - Make | and < work on FD side.
62 - Pass prefix_links to FD.
63 - Implement a M_SECURITY message class.
64 - Implement disk spooling. Two parts: 1. Spool to disk then
65   immediately to tape to speed up tape operations. 2. Spool to
66   disk only when the tape is full, then when a tape is hung move
67   it to tape.
68 - From Phil Stracchino:
69   It would probably be a per-client option, and would be called
70   something like, say, "Automatically purge obsoleted jobs".  What it
71   would do is, when you successfully complete a Differential backup of a
72   client, it would automatically purge all Incremental backups for that
73   client that are rendered redundant by that Differential.  Likewise,
74   when a Full backup on a client completed, it would automatically purge
75   all Differential and Incremental jobs obsoleted by that Full backup.
76   This would let people minimize the number of tapes they're keeping on
77   hand without having to master the art of retention times.
78
79 - Allow multiple Storage specifications (or multiple names on
80   a single Storage specification) in the Job record. Thus a job 
81   can be backed up to a number of storage devices.
82 - Implement dump/print label to UA
83 - Add prefixlinks to where or not where absolute links to FD.
84 - Look at Python for a Bacula scripting language -- www.python.org
85 - Issue message to mount a new tape before the rewind.
86 - Simplified client job initiation for portables.
87 - If SD cannot open a drive, make it periodically retry.
88 - Implement LabelTemplate (at least first cut).
89 - Add more of the config info to the tape label.
90 - Implement a Mount Command and an Unmount Command where
91   the users could specify a system command to be performed
92   to do the mount, after which Bacula could attempt to
93   read the device. This is for Removeable media such as a CDROM.
94   - Most likely, this mount command would be invoked explicitly
95   by the user using the current Console "mount" and "unmount" 
96   commands -- the Storage Daemon would do the right thing 
97   depending on the exact nature of the device.
98   - As with tape drives, when Bacula wanted a new removable
99   disk mounted, it would unmount the old one, and send a message
100   to the user, who would then use "mount" as described above 
101   once he had actually inserted the disk.
102
103 - Make some way so that if a machine is skipped because it is not up 
104   that Bacula will continue retrying for a specified period of time --
105   periodically.
106 - If tape is marked read-only, then try opening it read-only rather than
107   failing, and remember that it cannot be written.
108 - Refine SD waiting output:
109     Device is being positioned
110     >     Device is being positioned for append
111     >     Device is being positioned to file x
112     > 
113 - Figure out some way to estimate output size and to avoid splitting
114   a backup across two Volumes -- this could be useful for writing CDROMs
115   where you really prefer not to have it split -- not serious.
116 - Add RunBeforeJob and RunAfterJob to the Client program.
117 - Have SD compute MD5 or SHA1 and compare to what FD computes.
118 - Make VolumeToCatalog calculate an MD5 or SHA1 from the 
119   actual data on the Volume and compare it.                  
120 - Implement FileOptions (see end of this document)
121 - Implement Bacula plugins -- design API
122 - Make bcopy read through bad tape records.
123 - Fix read_record to handle multiple sessions.
124 - Program files (i.e. execute a program to read/write files).
125   Pass read date of last backup, size of file last time.
126 - Add Signature type to File DB record.
127 - Make Restore report an error if FD or SD term codes are not OK.
128 - CD into subdirectory when open()ing files for backup to
129   speed up things.  Test with testfind().
130 - Priority job to go to top of list.
131 - Find out why Full saves run slower and slower (hashing?)
132 - Why are save/restore of device different sizes (sparse?)   Yup! Fix it.
133 - Implement some way for the Console to dynamically create a job.
134 - Restore to a particular time -- e.g. before date, after date. 
135 - Solaris -I on tar for include list
136 - Prohibit backing up archive device (findlib/find_one.c:128)
137 - Need a verbose mode in restore, perhaps to bsr.
138 - bscan without -v is too quiet -- perhaps show jobs.
139 - Add code to reject whole blocks if not wanted on restore.
140 - Start working on Base jobs.
141 - Check if we can increase Bacula FD priorty in Win2000
142 - Make sure the MaxVolFiles is fully implemented in SD
143 - Check if both CatalogFiles and UseCatalog are set to SD.
144 - Need return status on read_cb() from read_records(). Need multiple
145   records -- one per Job, maybe a JCR or some other structure with
146   a block and a record.
147 - Figure out how to do a bare metal Windows restore
148 - Put system type returned by FD into catalog.
149 - Possibly add email to Watchdog if drive is unmounted too
150   long and a job is waiting on the drive.
151 - Use read_record.c in SD code.
152 - Why don't we get an error message from Win32 FD when bootstrap 
153   file cannot be created for restore command?
154 - When Marking a file in Restore that is a hard link, also
155   mark the link so that the data will be reloaded.
156 - Restore program that errors in SD due to no tape reports
157   OK incorrectly in output.
158 - After unmount, if restore job started, ask to mount.
159 - Convert all %x substitution variables, which are hard to remember
160   and read to %(variable-name).  Idea from TMDA.
161 - Add JobLevel in FD status (but make sure it is defined).
162 - Make Pool resource handle Counter resources.
163 - Remove NextId for SQLite. Optimize.
164 - Move all SQL statements into a single location.
165 - Add UA rc and history files.
166 - put termcap (used by console) in ./configure and
167   allow -with-termcap-dir.
168 - Enhance time and size scanning routines.
169 - Fix Autoprune for Volumes to respect need for full save.
170 - Fix Win32 config file definition name on /install
171 - No READLINE_SRC if found in alternate directory.
172 - Test a second language e.g. french.
173 - Compare tape to Client files (attributes, or attributes and data) 
174 - Make all database Ids 64 bit.
175 - Write an applet for Linux.
176 - Add estimate to Console commands
177 - Find solution to blank filename (i.e. path only) problem.
178 - Implement new daemon communications protocol.
179 - Remove PoolId from Job table, it exists in Media.
180 - Allow console commands to detach or run in background.
181 - Fix status delay on storage daemon during rewind.
182 - Add SD message variables to control operator wait time
183   - Maximum Operator Wait
184   - Minimum Message Interval
185   - Maximum Message Interval
186 - Send Operator message when cannot read tape label.
187 - Verify level=Volume (scan only), level=Data (compare of data to file).
188   Verify level=Catalog, level=InitCatalog
189 - Events file
190 - Add keyword search to show command in Console.
191 - Fix Win2000 error with no messages during startup.
192 - Events : tape has more than xxx bytes.
193 - Restrict characters permitted in a Resource name.
194 - Complete code in Bacula Resources -- this will permit
195   reading a new config file at any time.
196 - Handle ctl-c in Console
197 - Implement script driven addition of File daemon to config files.
198 - Think about how to make Bacula work better with File (non-tape) archives.
199 - Write Unix emulator for Windows.
200 - Implement new serialize subroutines
201    send(socket, "string", &Vol, "uint32", &i, NULL)
202 - Audit all UA commands to ensure that we always prompt where possible.
203 - If ./btape is called without /dev, assume argument is a Storage resource name.
204 - Put memory utilization in Status output of each daemon
205   if full status requested or if some level of debug on.
206 - Make database type selectable by .conf files i.e. at runtime
207 - Set flag for uname -a.  Add to Volume label.
208 - Implement throttled work queue.
209 - Check for EOT at ENOSPC or EIO or ENXIO (unix Pc)
210 - Restore files modified after date
211 - Restore file modified before date
212 - Emergency restore info:
213   - Backup Bacula
214   - Backup working directory
215   - Backup Catalog
216 - Restore -- do nothing but show what would happen
217 - SET LD_RUN_PATH=$HOME/mysql/lib/mysql
218 - Implement Restore FileSet=
219 - Create a protocol.h and protocol.c where all protocol messages
220   are concentrated.
221 - Remove duplicate fields from jcr (e.g. jcr.level and jcr.jr.Level, ...).
222 - Timout a job or terminate if link goes down, or reopen link and query.
223 - Find general solution for sscanf size problems (as well
224   as sprintf. Do at run time?
225 - Concept of precious tapes (cannot be reused).
226 - Make bcopy copy with a single tape drive.
227 - Permit changing ownership during restore.
228
229 - Autolabel should be specified by DIR instead of SD.
230 - Find out how to get the system tape block limits, e.g.:
231   Apr 22 21:22:10 polymatou kernel: st1: Block limits 1 - 245760 bytes.  
232   Apr 22 21:22:10 polymatou kernel: st0: Block limits 2 - 16777214 bytes.
233 - Storage daemon    
234   - Add media capacity
235   - AutoScan (check checksum of tape)
236   - Format command = "format /dev/nst0"
237   - MaxRewindTime
238   - MinRewindTime
239   - MaxBufferSize
240   - Seek resolution (usually corresponds to buffer size)
241   - EODErrorCode=ENOSPC or code
242   - Partial Read error code
243   - Partial write error code
244   - Nonformatted read error
245   - Nonformatted write error
246   - WriteProtected error
247   - IOTimeout
248   - OpenRetries
249   - OpenTimeout
250   - IgnoreCloseErrors=yes
251   - Tape=yes
252   - NoRewind=yes
253 - Pool
254   - Maxwrites
255   - Recycle period
256 - Job
257   - MaxWarnings
258   - MaxErrors (job?)
259 =====
260 - FD sends unsaved file list to Director at end of job (see
261   RFC below).
262 - File daemon should build list of files skipped, and then
263   at end of save retry and report any errors.
264 - Write a Storage daemon that uses pipes and
265   standard Unix programs to write to the tape.
266   See afbackup.
267 - Need something that monitors the JCR queue and
268   times out jobs by asking the deamons where they are.
269 - Enhance Jmsg code to permit buffering and saving to disk.
270 - device driver = "xxxx" for drives.
271 - restart: paranoid: read label fsf to
272   eom read append block, and go
273   super-paranoid: read label, read all files
274   in between, read append block, and go
275   verify: backspace, read append block, and go
276   permissive: same as above but frees drive
277   if tape is not valid.
278 - Verify from Volume
279 - Ensure that /dev/null works
280 - Need report class for messages. Perhaps
281   report resource where report=group of messages
282 - enhance scan_attrib and rename scan_jobtype, and
283   fill in code for "since" option 
284 - Director needs a time after which the report status is sent
285   anyway -- or better yet, a retry time for the job.
286   Don't reschedule a job if previous incarnation is still running.
287 - Some way to automatically backup everything is needed????
288 - Need a structure for pending actions:
289   - buffered messages
290   - termination status (part of buffered msgs?)
291 - Drive management
292   Read, Write, Clean, Delete
293 - Login to Bacula; Bacula users with different permissions:
294    owner, group, user, quotas
295 - Store info on each file system type (probably in the job header on tape.
296   This could be the output of df; or perhaps some sort of /etc/mtab record.
297
298 Longer term to do:
299 - Design at hierarchial storage for Bacula. Migration and Clone. 
300 - Implement FSM (File System Modules).
301 - Identify unchanged or "system" files and save them to a
302   special tape thus removing them from the standard 
303   backup FileSet -- BASE backup.
304 - Audit M_ error codes to ensure they are correct and consistent.
305 - Add variable break characters to lex analyzer.
306   Either a bit mask or a string of chars so that
307   the caller can change the break characters.
308 - Make a single T_BREAK to replace T_COMMA, etc.
309 - Ensure that File daemon and Storage daemon can
310   continue a save if the Director goes down (this
311   is NOT currently the case). Must detect socket error,
312   buffer messages for later. 
313 - Enhance time/duration input to allow multiple qualifiers e.g. 3d2h
314 - Add ability to backup to two Storage devices (two SD sessions) at
315   the same time -- e.g. onsite, offsite.
316 - Add the ability to consolidate old backup sets (basically do a restore
317   to tape and appropriately update the catalog). Compress Volume sets.
318   Might need to spool via file is only one drive is available.
319 - Compress or consolidate Volumes of old possibly deleted files. Perhaps
320   someway to do so with every volume that has less than x% valid 
321   files.
322
323   
324 Projects:
325             Bacula Projects Roadmap 
326                17 August 2002
327            last update 8 May 2003
328
329 Item 1:   Multiple simultaneous Jobs. (done)
330 Done -- Restore part needs better implementation to work correctly
331         Also, it needs considerable testing
332
333   What:   Permit multiple simultaneous jobs in Bacula.
334
335   Why:    An enterprise level solution needs to go fast without the
336           need for the system administrator to carefully tweak
337           timing.  Based on the benchmarks, during a full
338           backup, NetWorker typically hit 10 times the bandwidth to
339           the tape compared to Bacula--largely. This is probably due to
340           running parallel jobs and multi-threaded filling of buffers
341           and writing them to tape.  This should also make things work
342           better when you have a mix of fast and slow machines backing
343           up at the same time.
344
345   Notes:  Bacula was designed to run multiple simultaneous jobs. Thus
346           implementing this is a matter of some small cleanups and
347           careful testing.
348
349
350 Item 2:   Make the Storage daemon use intermediate file storage to buffer data.
351 Deferred -- not necessary yet.
352
353   What:   If data is coming into the SD too fast, buffer it to 
354           disk if the user has configured this option.
355
356   Why:    This would be nice, especially if it more or less falls out
357           when implementing (1) above.  If not, it probably should not
358           be given a high priority because fundamentally the backup time
359           is limited by the tape bandwidth.  Even though you may finish a
360           client job quicker by spilling to disk, you still have to
361           eventually get it onto tape.  If intermediate disk buffering
362           allows us to improve write bandwidth to tape, it may make
363           sense.
364
365   Notes:  Whether or not this is implemented will depend upon performance
366           testing after item 1 is implemented.
367
368
369 Item 3:   Write the bscan program -- also write a bcopy program.
370 Done
371
372   What:   Write a program that reads a Bacula tape and puts all the 
373           appropriate data into the catalog. This allows recovery
374           from a tape that is no longer in the database, or it allows
375           re-creation of a database if lost.
376
377   Why:    This is a fundamental robustness and disaster recovery tool
378           which will increase the comfort level of a sysadmin
379           considering adopting Bacula.
380
381   Notes:  A skeleton of this program already exists, but much work
382           needs to be done. Implementing this will also make apparent
383           any deficiencies in the current Bacula tape format.
384
385
386 Item 4:   Implement Base jobs.
387
388   What:   A base job is sort of like a Full save except that you 
389           will want the FileSet to contain only files that are unlikely
390           to change in the future (i.e. a snapshot of most of your
391           system after installing it). After the base job has been run,
392           when you are doing a Full save, you can specify to exclude
393           all files saved by the base job that have not been modified.
394
395   Why:    This is something none of the competition does, as far as we know
396           (except BackupPC, which is a Perl program that saves to disk
397           only).  It is big win for the user, it makes Bacula stand out
398           as offering a unique optimization that immediately saves time
399           and money.
400
401   Notes:  Big savings in tape usage. Will require more resources because
402           the e. DIR must send FD a list of files/attribs, and the FD must
403           search the list and compare it for each file to be saved.
404
405
406 Item 5:   Implement Label templates
407
408   What:   This is a mechanism whereby Bacula can automatically create
409           a tape label for new tapes according to a detailed specification
410           provided by the user.
411
412   Why:    It is a major convenience item for folks who use automated label
413           creation.
414
415   Notes:  Bacula already has a working form of automatic tape label
416           creation, but it is very crude. The design for the complete
417           tape labeling project is already documented in the manual.
418
419
420 Item 6:   Write a regression script.
421 Done --   Continue to expand its testing.
422
423   What:   This is an automatic script that runs and tests as many features
424           of Bacula as possible. The output is compared to previous
425           versions of Bacula and any differences are reported.
426
427   Why:    This is an enormous help in preventing introduction of new
428           errors in parts of the program that already work correctly.
429
430   Notes:  This probably should be ranked higher, it's something the typical
431           user doesn't see.  Depending on how it's implemented, it may
432           make sense to defer it until the archival tape format and
433           user interface mature.
434
435
436 Item 7:   GUI for interactive restore
437 Item 8:   GUI for interactive backup
438
439   What:   The current interactive restore is implemented with a tty
440           interface. It would be much nicer to be able to "see" the
441           list of files backed up in typical GUI tree format.
442           The same mechanism could also be used for creating 
443           ad-hoc backup FileSets (item 8).
444
445   Why:    Ease of use -- especially for the end user.
446
447   Notes:  Rather than implementing in Gtk, we probably should go directly
448           for a Browser implementation, even if doing so meant the
449           capability wouldn't be available until much later.  Not only
450           is there the question of Windows sites, most
451           Solaris/HP/IRIX, etc,  shops can't currently run Gtk programs
452           without installing lots of stuff admins are very wary about.
453           Real sysadmins will always use the command line anyway, and
454           the user who's doing an interactive restore or backup of his
455           own files will in most cases be on a Windows machine running
456           Exploder.
457
458
459 Item 9:   Add SSL to daemon communications.
460 Inprogress as of version 1.31.
461
462   What:   This provides for secure communications between the daemons.
463
464   Why:    This would allow doing backup across the Internet without
465           privacy concerns (or with much less concern).
466
467   Notes:  The vast majority of near term potential users will be backing up
468           a single site over a LAN and, correctly or not, they probably
469           won't be concerned with security, at least not enough to go to
470           the trouble to set up keys, etc. to screw things down.  We suspect
471           that many users genuinely interested in multi-site backup
472           already run some form of VPN software in their internetwork
473           connections, and are willing to delegate security to that layer.
474
475
476 Item 10:  Define definitive tape format.
477 Done (version 1.27)
478
479   What:   Define that definitive tape format that will not change 
480           for the next millennium.
481
482   Why:    Stability, security.
483
484   Notes:  See notes for item 11 below.
485
486
487 Item 11:  New daemon communication protocol.
488
489   What:   The current daemon to daemon protocol is basically an ASCII
490           printf() and sending the buffer. On the receiving end, the
491           buffer is sscanf()ed to unpack it. The new scheme would
492           be a binary format that allows quick packing and unpacking
493           of any data type with named fields.
494
495   Why:    Using binary packing would be faster. Named fields will permit
496           error checking to ensure that what is sent is what the 
497           receiver really wants.
498
499   Notes:  These are internal improvements in the interest of the
500           long-term stability and evolution of the program.  On the one
501           hand, the sooner they're done, the less code we have to rip
502           up when the time comes to install them.  On the other hand, they
503           don't bring an immediately perceptible benefit to potential
504           users.  Item 10 and possibly item 11 should be deferred until Bacula
505           is well established with a growing user community more or
506           less happy with the feature set.  At that time, it will make a
507           good "next generation" upgrade in the interest of data
508           immortality.
509
510
511
512
513 ======================================================
514         Base Jobs design
515 It is somewhat like a Full save becomes an incremental since
516 the Base job (or jobs) plus other non-base files.
517 Need:
518 - New BaseFile table that contains:
519     JobId, BaseJobId, FileId (from Base).
520   i.e. for each base file that exists but is not saved because
521   it has not changed, the File daemon sends the JobId, BaseId,
522   and FileId back to the Director who creates the DB entry.
523 - To initiate a Base save, the Director sends the FD 
524   the FileId, and full filename for each file in the Base.
525 - When the FD finds a Base file, he requests the Director to
526   send him the full File entry (stat packet plus MD5), or
527   conversely, the FD sends it to the Director and the Director
528   says yes or no. This can be quite rapid if the FileId is kept
529   by the FD for each Base Filename.          
530 - It is probably better to have the comparison done by the FD
531   despite the fact that the File entry must be sent across the
532   network.
533 - An alternative would be to send the FD the whole File entry
534   from the start. The disadvantage is that it requires a lot of
535   space. The advantage is that it requires less communications
536   during the save.
537 - The Job record must be updated to indicate that one or more
538   Bases were used.
539 - At end of Job, FD returns:   
540    1. Count of base files/bytes not written to tape (i.e. matches)
541    2. Count of base file that were saved i.e. had changed.
542 - No tape record would be written for a Base file that matches, in the
543   same way that no tape record is written for Incremental jobs where
544   the file is not saved because it is unchanged.
545 - On a restore, all the Base file records must explicitly be
546   found from the BaseFile tape. I.e. for each Full save that is marked
547   to have one or more Base Jobs, search the BaseFile for all occurrences
548   of JobId.
549 - An optimization might be to make the BaseFile have:
550      JobId
551      BaseId
552      FileId
553   plus
554      FileIndex
555   This would avoid the need to explicitly fetch each File record for
556   the Base job.  The Base Job record will be fetched to get the
557   VolSessionId and VolSessionTime.
558 =========================================================  
559
560   
561
562 =============================================================
563
564                 Request For Comments For File Backup Options
565                    10 November 2002
566
567 Subject: File Backup Options
568
569 Problem: 
570   A few days ago, a Bacula user who is backing up to file volumes and
571   using compression asked if it was possible to suppress compressing
572   all .gz files since it was a waste of CPU time. Although Bacula
573   currently permits using different options (compression, ...) on
574   a directory by directory basis, it cannot do it on a file by 
575   file basis, which is clearly what was desired.   
576
577 Proposed Implementation:
578   To solve this problem, I propose the following:
579
580   - Add a new Director resource type called FileOptions.  
581
582   - The FileOptions resource will have records for all
583     options that can currently be specified on the Include record 
584     (in a FileSet).  Examples below.
585
586   - The FileOptions resource will permit an exclude option as well
587     as a number of additional options.
588
589   - The heart of the FileOptions resource is the ability to
590     supply any number of ApplyTo records which specify POSIX
591     regular expressions.  These ApplyTo regular expressions are
592     applied to the fully qualified filename (path and all). If
593     one matches, then the FileOptions will be used.
594
595   - When an ApplyTo specification matches an included file, the
596     options specified in the FileOptions resource will override
597     the default options specified on the Include record.
598
599   - Include records will be modified to permit referencing one or
600     more FileOptions resources.  The FileOptions will be used
601     in the order listed on the Include record and the first
602     one that matches will be applied.
603
604   - Options (or specifications) currently supplied on the Include
605     record will be deprecated (i.e. removed in a later version a
606     year or so from now).
607
608   - The Exclude record will be deprecated as the same functionality
609     can be obtained by using an Exclude = yes in the FileOptions.
610
611 FileOptions records:
612   The following records can appear in the FileOptions resource. An
613   asterisk preceding the name indicates a feature not currently
614   implemented.
615
616   For Backup Jobs:
617     - Compression= (GZIP, ...)
618     - Signature=   (MD5, SHA1, ...)
619     - *Encryption=
620     - OneFs=      (yes/no)    - remain on one filesystem
621     - Recurse=    (yes/no)    - recurse into subdirectories
622     - Sparse=     (yes/no)    - do sparse file backup
623     - *Exclude=   (yes/no)    - exclude file from being saved
624     - *Reader=    (filename)  - external read (backup) program
625     - *Plugin=    (filename)  - read/write plugin module
626
627   For Verify Jobs:
628     - verify=     (ipnougsamc5) - verify options
629
630   For Restore Jobs:
631     - replace= (always/ifnewer/ifolder/never) - replace options currently
632                                                 implemented in 1.27
633     - *Writer= (filename)   - external write (restore) program
634
635
636 Implementation:
637   Currently options specifying compression, MD5 signatures, recursion,
638   ... of a FileSet are supplied on the Include record. These will now
639   all be collected into a FileOptions resource, which will be
640   specified on the Include in place of the options. Multiple FileOptions
641   may be specified.  Since the FileOptions contain regular expressions
642   that are applied to the full filename, this will give the ability
643   to specify backup options on a file by file basis to whatever level
644   of detail you wish.
645
646 Example:
647
648   Today:
649
650     FileSet {
651       Name = "FullSet"
652       Include = compression=GZIP signature=MD5 {
653         /
654       }
655     }
656
657   Proposal:
658
659     FileSet {
660       Name = "FullSet"
661       Include = FileOptions=Opts {
662         /
663       }
664     }
665     FileOptions {
666       Name = Opts
667       Compression = GZIP
668       Signature = MD5
669       ApplyTo = /*.?*/
670     }
671
672   That's a lot more to do the same thing, but it gives the ability to
673   apply options on a file by file basis.  For example, suppose you
674   want to compress all files but not any file with extensions .gz or .Z.
675   You could do so as follows:
676
677     FileSet {
678       Name = "FullSet"
679       Include = FileOptions=NoCompress FileOptions=Opts {
680         /
681       }
682     }
683     FileOptions {
684       Name = Opts
685       Compression = GZIP
686       Signature = MD5
687       ApplyTo = /*.?*/   # matches all files
688     }
689     FileOptions {
690       Name = NoCompress
691       Signature = MD5
692       # Note multiple ApplyTos are ORed
693       ApplyTo = /*.gz/   # matches .gz files */
694       ApplyTo = /*.Z/    # matches .Z files */
695     }
696
697   Now, since the NoCompress FileOptions is specified first on the
698   Include line, any *.gz or *.Z file will have an MD5 signature computed,
699   but will not be compressed. For all other files, the NoCompress will not
700   match, so the Opts options will be used which will include GZIP
701   compression.
702
703 Questions:
704   - Is it necessary to provide some means of ANDing regular expressions
705     and negation?  (not currently planned)
706
707     e.g.  ApplyTo = /*.gz/ && !/big.gz/
708
709   - I see that Networker has a "null" module which, if specified, does not 
710     backup the file, but does make an record of the file in the catalog
711     so that the catalog will reflect an exact picture of the filesystem.
712     The result is that the file can be "seen" when "browsing" the save
713     sets, but it cannot be restored.
714     
715     Is this really useful?  Should it be implemented in Bacula?
716   
717 Results:
718   After implementing the above, the user will be able to specify
719   on a file by file basis (using regular expressions) what options are
720   applied for the backup.
721
722
723 =============================================
724
725 ========================================================== 
726     Unsaved File design
727 For each Incremental job that is run, there may be files that
728 were found but not saved because they were locked (this applies
729 only to Windows). Such a system could send back to the Director
730 a list of Unsaved files.
731 Need:
732 - New UnSavedFiles table that contains:
733   JobId
734   PathId
735   FilenameId
736 - Then in the next Incremental job, the list of Unsaved Files will be
737   feed to the FD, who will ensure that they are explicitly chosen even
738   if standard date/time check would not have selected them.
739 =============================================================
740
741
742 Done: (see kernsdone for more)
743 - Heartbeat between daemons.
744 - Fix Dir heartbeat in restore and verify vol.  Be sure to make
745   bnet_recv() ignore BNET_HEARTBEAT.
746 - Implement HEART_BEAT while SD waiting for tapes.
747 - Include RunBeforeJob and RunAfterJob output in the message
748   stream.
749 - Change M_INFO to M_RESTORED for all restored files.
750 - Fix command prompt in gnome-console by checking on Ready.