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