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