git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/README

   1
   2 This directory contains the Bacula Admin Tool (bat).
   3
   4 At the current time, the contents of this directory are under
   5 development.  If you want to help, please contact Kern directly.
   6 If you want to build it, you need Qt4 loaded and setup as your
   7 default Qt or with the appropriate Qt Environment variables set.
   8
   9 To build bat, you simply enter:
  10
  11   qmake
  12   make
  13
  14 then to execute it
  15
  16   ./bat
  17
  18 The qmake command needs to be entered only if you add a new file, in
  19 which case, you should edit bat.pro.in and add the new filename
  20 in the appropriate place.  In running qmake, it will build a new
  21 Makefile, and there after, you simply use "make". In fact, providing
  22 you edit bat.pro, doing a "make" will automatically call qmake to
  23 rebuild the Makefile.
  24
  25 From the base bacula directory, make Makefiles will generate bat.pro from
  26 bat.pro.in, so only edit bat.pro.in.   It will also overwrite the qt-consoles
  27 bat.conf file.  "make install" will write /etc/bacula/bat.conf.  bat.conf can
  28 include as many director stanza's as you would like in bat.conf.  You may use
  29 this directories bat.conf.example as a template for director stanza's.
  30
  31 Development status as of 05/06/07
  32
  33 Items not implemented:
  34 - Nothing on the brestore page
  35
  36 Design decisions:
  37 - If possible all code for a particular component will be kept in
  38   and appropriate subdirectory.
  39 - All private class variables are named "m_xxx" this makes it very
  40   clear if one is referencing a class variable or a local.
  41 - All signal/slots are connected by explict code (most all are
  42   done in the MainWin constructor), rather than using designer.
  43 - Each page has a separate designer .ui file in a subdirectory.
  44 - All windows are created with designer and have
  45   a name such as xxxForm i.e. the main window is MainForm and kept
  46   in main.ui.
  47
  48 Major projects:
  49 - Implement other restore interfaces such as brestore ...
  50 - Implement a database browser
  51 - Implement a resource (conf file) browser
  52 - Implement a reports page -- e.g. something similar to bweb
  53 - Implement Qt plugins to add new functionality to bat
  54 - Implement a GUI configuration file editor (something like JBacula).
  55 ...
  56
  57 Partially Done:
  58 ===========================
  59 - Implement graphical commands that allow updating most aspects of
  60   the database (i.e. commands for label, update Volume, ...)
  61       still need to be able to edit a pool object
  62
  63 - None of the menu items except About, Select Font, and Quit.
  64     Print and save don't do anything, does save need to??
  65 Done:
  66 ============================
  67 Design/implementation considerations:
  68 - Need icons in front of the Director.
  69 - The console page should be in a DockWidget so it can be removed
  70   from the main window. It is currently in a dock window, but it
  71   does not remove properly -- more research needed.
  72 - Need to figure out a good implementation of adding pages and even
  73   having plugins that load as pages.  Currently the page mechanism
  74   is a bit kludged.
  75
  76 - We need to have multiple Directors
  77 - Each Director should have its own console
  78 - The Console class needs to be a list or be attached to the
  79   currently active Director.
  80 - Will automatically connnect to the first Director in the
  81   conf file. Doesn't know about multiple Directors.
  82
  83 - The Label menu bar item, prints on the shell window what you entered.
  84 - The Run menu bar item, prints on the console window what you entered.
  85 - The Restore menu bar item, brings up dialog, then when OK is
  86   clicked, it goes on to the next dialog, which is meant to be
  87   a tree view, but for the moment does nothing ...  It is a bit
  88   ugly. Cancelling it should get you back to the normal command prompt.
  89
  90 - Implement a restore page that does a directory tree restore selection
  91   much like wx-console does.
  92
  93 Not working:
  94 - The left selection window and the right window (where the console
  95   is) are dockable windows so should be movable once they are properly
  96   clicked.  Well, they sort of move, but then get stuck.  I haven't figured
  97   out what is going on, so for the current time, I am implemeting most
  98   stuff through dialogs.
  99
 100 Items implemented:
 101 - Reads a basic bat.conf (same as documented for the gnome-console
 102    except that the Font part is unimplemented).
 103 - Basic main window structure
 104 - About dialog
 105 - Quit menu item
 106 - The Director name will appear in the Selection tree followed
 107   by Console and Restore.
 108 - Clicking on Console brings forward the console display screen
 109   (default at startup).
 110 - The command line is implemented.
 111 - The status line (below the command line) is implemented.
 112 - Selection of Font is implemented.
 113 - The Font and the window size are saved on exit and restored on
 114   execution of bat.
 115 - The Status menu bar icon is implemented.