git.sur5r.net Git - bacula/bacula/blob - bacula/src/wx-console/wxbmainframe.cpp

   1 /*
   2  *
   3  *   Main frame
   4  *
   5  *    Nicolas Boichat, April 2004
   6  *
   7  */
   8 /*
   9    Copyright (C) 2004 Kern Sibbald and John Walker
  10
  11    This program is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU General Public License
  13    as published by the Free Software Foundation; either version 2
  14    of the License, or (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program; if not, write to the Free Software
  23    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #include "wxbmainframe.h" // class's header file
  27
  28 #include "wxbrestorepanel.h"
  29
  30 #include "csprint.h"
  31
  32 #include "wxwin16x16.xpm"
  33
  34 #include <wx/arrimpl.cpp>
  35
  36 // ----------------------------------------------------------------------------
  37 // event tables and other macros for wxWindows
  38 // ----------------------------------------------------------------------------
  39
  40 // ----------------------------------------------------------------------------
  41 // constants
  42 // ----------------------------------------------------------------------------
  43
  44 // IDs for the controls and the menu commands
  45 enum
  46 {
  47    // menu items
  48    Minimal_Quit = 1,
  49
  50    // it is important for the id corresponding to the "About" command to have
  51    // this standard value as otherwise it won't be handled properly under Mac
  52    // (where it is special and put into the "Apple" menu)
  53    Minimal_About = wxID_ABOUT,
  54    TypeText = 2,
  55    Thread = 3
  56 };
  57
  58 /*
  59  *   wxbTHREAD_EVENT declaration, used by csprint
  60  */
  61 BEGIN_DECLARE_EVENT_TYPES()
  62    DECLARE_EVENT_TYPE(wxbTHREAD_EVENT,       1)
  63 END_DECLARE_EVENT_TYPES()
  64
  65 DEFINE_EVENT_TYPE(wxbTHREAD_EVENT)
  66
  67 // the event tables connect the wxWindows events with the functions (event
  68 // handlers) which process them. It can be also done at run-time, but for the
  69 // simple menu events like this the static method is much simpler.
  70 BEGIN_EVENT_TABLE(wxbMainFrame, wxFrame)
  71    EVT_MENU(Minimal_Quit,  wxbMainFrame::OnQuit)
  72    EVT_MENU(Minimal_About, wxbMainFrame::OnAbout)
  73    EVT_TEXT_ENTER(TypeText, wxbMainFrame::OnEnter)
  74    EVT_CUSTOM(wxbTHREAD_EVENT, Thread, wxbMainFrame::OnPrint)
  75 END_EVENT_TABLE()
  76
  77 // ----------------------------------------------------------------------------
  78 // wxbThreadEvent
  79 // ----------------------------------------------------------------------------
  80
  81 /*
  82  *  wxbThreadEvent constructor
  83  */
  84 wxbThreadEvent::wxbThreadEvent(int id): wxEvent(id, wxbTHREAD_EVENT) {
  85    m_eventObject = NULL;
  86 }
  87
  88 /*
  89  *  wxbThreadEvent destructor
  90  */
  91 wxbThreadEvent::~wxbThreadEvent()
  92 {
  93    if (m_eventObject != NULL) {
  94       delete m_eventObject;
  95    }
  96 }
  97
  98 /*
  99  *  wxbThreadEvent copy constructor
 100  */
 101 wxbThreadEvent::wxbThreadEvent(const wxbThreadEvent& te)
 102 {
 103    this->m_eventType = te.m_eventType;
 104    this->m_id = te.m_id;
 105    if (te.m_eventObject != NULL) {
 106       this->m_eventObject = new wxbPrintObject(*((wxbPrintObject*)te.m_eventObject));
 107    }
 108    else {
 109       this->m_eventObject = NULL;
 110    }
 111    this->m_skipped = te.m_skipped;
 112    this->m_timeStamp = te.m_timeStamp;
 113 }
 114
 115 /*
 116  *  Must be implemented (abstract in wxEvent)
 117  */
 118 wxEvent* wxbThreadEvent::Clone() const
 119 {
 120    return new wxbThreadEvent(*this);
 121 }
 122
 123 /*
 124  *  Gets the wxbPrintObject attached to this event, containing data sent by director
 125  */
 126 wxbPrintObject* wxbThreadEvent::GetEventPrintObject()
 127 {
 128    return (wxbPrintObject*)m_eventObject;
 129 }
 130
 131 /*
 132  *  Sets the wxbPrintObject attached to this event
 133  */
 134 void wxbThreadEvent::SetEventPrintObject(wxbPrintObject* object)
 135 {
 136    m_eventObject = (wxObject*)object;
 137 }
 138
 139 // ----------------------------------------------------------------------------
 140 // main frame
 141 // ----------------------------------------------------------------------------
 142
 143 wxbMainFrame *wxbMainFrame::frame = NULL;
 144
 145 /*
 146  *  Singleton constructor
 147  */
 148 wxbMainFrame* wxbMainFrame::CreateInstance(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
 149 {
 150    frame = new wxbMainFrame(title, pos, size, style);
 151    return frame;
 152 }
 153
 154 /*
 155  *  Returns singleton instance
 156  */
 157 wxbMainFrame* wxbMainFrame::GetInstance()
 158 {
 159    return frame;
 160 }
 161
 162 /*
 163  *  Private destructor
 164  */
 165 wxbMainFrame::~wxbMainFrame()
 166 {
 167    if (ct != NULL) { // && (!ct->IsRunning())
 168       ct->Delete();
 169    }
 170 }
 171
 172 /*
 173  *  Private constructor
 174  */
 175 wxbMainFrame::wxbMainFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
 176       : wxFrame(NULL, -1, title, pos, size, style)
 177 {
 178    ct = NULL;
 179
 180    // set the frame icon
 181    SetIcon(wxIcon(wxwin16x16_xpm));
 182
 183 #if wxUSE_MENUS
 184    // create a menu bar
 185    wxMenu *menuFile = new wxMenu;
 186
 187    // the "About" item should be in the help menu
 188    wxMenu *helpMenu = new wxMenu;
 189    helpMenu->Append(Minimal_About, _T("&About...\tF1"), _T("Show about dialog"));
 190
 191    menuFile->Append(Minimal_Quit, _T("E&xit\tAlt-X"), _T("Quit this program"));
 192
 193    // now append the freshly created menu to the menu bar...
 194    wxMenuBar *menuBar = new wxMenuBar();
 195    menuBar->Append(menuFile, _T("&File"));
 196    menuBar->Append(helpMenu, _T("&Help"));
 197
 198    // ... and attach this menu bar to the frame
 199    SetMenuBar(menuBar);
 200 #endif // wxUSE_MENUS
 201
 202 #if wxUSE_STATUSBAR
 203    CreateStatusBar(1);
 204    SetStatusText(wxString("Welcome to bacula wx-console ") << VERSION << " (" << BDATE << ")!\n");
 205 #endif // wxUSE_STATUSBAR
 206
 207    wxPanel* global = new wxPanel(this, -1);
 208
 209    notebook = new wxNotebook(global, -1);
 210
 211    /* Console */
 212
 213    wxPanel* consolePanel = new wxPanel(notebook, -1);
 214    notebook->AddPage(consolePanel, "Console");
 215
 216    consoleCtrl = new wxTextCtrl(consolePanel,-1,"",wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE | wxTE_READONLY | wxTE_RICH);
 217    consoleCtrl->SetDefaultStyle(wxTextAttr(*wxBLACK, wxNullColour, wxFont(10, wxMODERN, wxNORMAL, wxNORMAL)));
 218
 219    typeCtrl = new wxTextCtrl(consolePanel,TypeText,"",wxDefaultPosition,wxSize(200,20), wxTE_PROCESS_ENTER);
 220
 221    wxFlexGridSizer *consoleSizer = new wxFlexGridSizer(2, 1, 0, 0);
 222    consoleSizer->AddGrowableCol(0);
 223    consoleSizer->AddGrowableRow(0);
 224
 225    consoleSizer->Add(consoleCtrl, 1, wxEXPAND | wxALL, 0);
 226    consoleSizer->Add(typeCtrl, 0, wxEXPAND | wxALL, 0);
 227
 228    consolePanel->SetAutoLayout( TRUE );
 229    consolePanel->SetSizer( consoleSizer );
 230    consoleSizer->SetSizeHints( consolePanel );
 231
 232    // Creates the list of panels which are included in notebook, and that need to receive director information
 233
 234    panels = new wxbPanel* [2];
 235    panels[0] = new wxbRestorePanel(notebook);
 236    panels[1] = NULL;
 237
 238    for (int i = 0; panels[i] != NULL; i++) {
 239       notebook->AddPage(panels[i], panels[i]->GetTitle());
 240    }
 241
 242    wxBoxSizer* globalSizer = new wxBoxSizer(wxHORIZONTAL);
 243
 244    globalSizer->Add(new wxNotebookSizer(notebook), 1, wxEXPAND, 0);
 245
 246    global->SetSizer( globalSizer );
 247    globalSizer->SetSizeHints( global );
 248
 249    wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
 250
 251    sizer->Add(global, 1, wxEXPAND | wxALL, 0);
 252    SetAutoLayout(true);
 253    SetSizer( sizer );
 254    sizer->SetSizeHints( this );
 255    this->SetSize(size);
 256    EnableConsole(false);
 257 }
 258
 259 /*
 260  *  Starts the thread interacting with the director
 261  */
 262 void wxbMainFrame::StartConsoleThread()
 263 {
 264    if (ct != NULL) {
 265       ct->Delete();
 266    }
 267    else {
 268       promptparser = new wxbPromptParser();
 269    }
 270    ct = new console_thread();
 271    ct->Create();
 272    ct->Run();
 273    SetStatusText("Connecting to the director...");
 274 }
 275
 276 /* Register a new wxbDataParser */
 277 void wxbMainFrame::Register(wxbDataParser* dp) {
 278    parsers.Add(dp);
 279 }
 280
 281 /* Unregister a wxbDataParser */
 282 void wxbMainFrame::Unregister(wxbDataParser* dp) {
 283    int index;
 284    if ((index = parsers.Index(dp)) != wxNOT_FOUND) {
 285       parsers.RemoveAt(index);
 286    }
 287    else {
 288       Print("Failed to unregister a data parser !", CS_DEBUG);
 289    }
 290 }
 291
 292 // event handlers
 293
 294 void wxbMainFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 295 {
 296    // TRUE is to force the frame to close
 297    Close(TRUE);
 298 }
 299
 300 void wxbMainFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 301 {
 302    wxString msg;
 303    msg.Printf( _T("Welcome to Bacula wx-console.\nWritten by Nicolas Boichat <nicolas@boichat.ch>\n(C) 2004 Kern Sibbald and John Walker\n"));
 304
 305    wxMessageBox(msg, _T("About Bacula wx-console"), wxOK | wxICON_INFORMATION, this);
 306 }
 307
 308 void wxbMainFrame::OnEnter(wxCommandEvent& WXUNUSED(event))
 309 {
 310    wxString str = typeCtrl->GetValue() + "\n";
 311    Send(str);
 312 }
 313
 314 /*
 315  *  Called when data is arriving from director
 316  */
 317 void wxbMainFrame::OnPrint(wxbThreadEvent& event) {
 318    wxbPrintObject* po = event.GetEventPrintObject();
 319
 320    Print(po->str, po->status);
 321 }
 322
 323 /*
 324  *  Prints data received from director to the console, and forwards it to the panels
 325  */
 326 void wxbMainFrame::Print(wxString str, int status)
 327 {
 328    if (status == CS_TERMINATED) {
 329       SetStatusText("Console thread terminated.");
 330       ct = NULL;
 331       DisablePanels();
 332       return;
 333    }
 334
 335    if (status == CS_CONNECTED) {
 336       SetStatusText("Connected to the director.");
 337       EnablePanels();
 338       return;
 339    }
 340    if (status == CS_DISCONNECTED) {
 341       SetStatusText("Disconnected of the director.");
 342       DisablePanels();
 343       return;
 344    }
 345
 346    // CS_DEBUG is often sent by panels,
 347    // and resend it to them would sometimes cause infinite loops
 348
 349    /* One promptcaught is normal, so we must have two true Print values to be
 350     * sure that the prompt has effectively been caught.
 351     */
 352    int promptcaught = -1;
 353
 354    if (status != CS_DEBUG) {
 355       for (unsigned int i = 0; i < parsers.GetCount(); i++) {
 356          promptcaught += parsers[i]->Print(str, status) ? 1 : 0;
 357       }
 358
 359       if ((status == CS_PROMPT) && (promptcaught < 1) && (promptparser->isPrompt())) {
 360          Print("Unexpected question has been received.\n", CS_DEBUG);
 361 //         Print(wxString("(") << promptparser->getIntroString() << "/-/" << promptparser->getQuestionString() << ")\n", CS_DEBUG);
 362
 363          wxString message;
 364          if (promptparser->getIntroString() != "") {
 365             message << promptparser->getIntroString() << "\n";
 366          }
 367          message << promptparser->getQuestionString();
 368
 369          if (promptparser->getChoices()) {
 370             wxString *choices = new wxString[promptparser->getChoices()->GetCount()];
 371             int *numbers = new int[promptparser->getChoices()->GetCount()];
 372             int n = 0;
 373
 374             for (unsigned int i = 0; i < promptparser->getChoices()->GetCount(); i++) {
 375                if ((*promptparser->getChoices())[i] != "") {
 376                   choices[n] = (*promptparser->getChoices())[i];
 377                   numbers[n] = i;
 378                   n++;
 379                }
 380             }
 381
 382             int res = ::wxGetSingleChoiceIndex(message,
 383                "wx-console: unexpected director's question.", n, choices, this);
 384             if (res == -1) {
 385                Send("\n");
 386             }
 387             else {
 388                Send(wxString() << numbers[res] << "\n");
 389             }
 390          }
 391          else {
 392             Send(::wxGetTextFromUser(message,
 393                "wx-console: unexpected director's question.", "", this) + "\n");
 394          }
 395       }
 396    }
 397
 398    if (status == CS_END) {
 399       str = "#";
 400    }
 401
 402    if (status == CS_DEBUG) {
 403       consoleCtrl->SetDefaultStyle(wxTextAttr(wxColour(0, 128, 0)));
 404    }
 405    else {
 406       consoleCtrl->SetDefaultStyle(wxTextAttr(*wxBLACK));
 407    }
 408    consoleCtrl->AppendText(str);
 409    if (status == CS_PROMPT) {
 410       consoleCtrl->AppendText("<P>");
 411    }
 412
 413    consoleCtrl->ScrollLines(3);
 414
 415 //   consoleCtrl->ShowPosition(consoleCtrl->GetLastPosition());
 416
 417    /*if (status != CS_DEBUG) {
 418       consoleCtrl->AppendText("@");
 419    }*/
 420    //consoleCtrl->SetInsertionPointEnd();
 421
 422 /*   if ((consoleCtrl->GetNumberOfLines()-1) > nlines) {
 423       nlines = consoleCtrl->GetNumberOfLines()-1;
 424    }
 425
 426    if (status == CS_END) {
 427       consoleCtrl->ShowPosition(nlines);
 428    }*/
 429 }
 430
 431 /*
 432  *  Sends data to the director
 433  */
 434 void wxbMainFrame::Send(wxString str)
 435 {
 436    ct->Write((const char*)str);
 437    typeCtrl->SetValue("");
 438    consoleCtrl->SetDefaultStyle(wxTextAttr(*wxRED));
 439    consoleCtrl->AppendText(str);
 440    consoleCtrl->ScrollLines(3);
 441
 442 /*   if ((consoleCtrl->GetNumberOfLines()-1) > nlines) {
 443       nlines = consoleCtrl->GetNumberOfLines()-1;
 444    }
 445
 446    consoleCtrl->ShowPosition(nlines);*/
 447 }
 448
 449 /* Enable panels */
 450 void wxbMainFrame::EnablePanels() {
 451    for (int i = 0; panels[i] != NULL; i++) {
 452       panels[i]->EnablePanel(true);
 453    }
 454    EnableConsole(true);
 455 }
 456
 457 /* Disable panels, except the one passed as parameter */
 458 void wxbMainFrame::DisablePanels(void* except) {
 459    for (int i = 0; panels[i] != NULL; i++) {
 460       if (panels[i] != except) {
 461          panels[i]->EnablePanel(false);
 462       }
 463       else {
 464          panels[i]->EnablePanel(true);
 465       }
 466    }
 467    if (this != except) {
 468       EnableConsole(false);
 469    }
 470 }
 471
 472 /* Enable or disable console typing */
 473 void wxbMainFrame::EnableConsole(bool enable) {
 474    typeCtrl->Enable(enable);
 475    typeCtrl->SetFocus();
 476 }
 477
 478 /*
 479  *  Used by csprint, which is called by console thread.
 480  *
 481  *  In GTK and perhaps X11, only the main thread is allowed to interact with
 482  *  graphical components, so by firing an event, the main loop will call OnPrint.
 483  *
 484  *  Calling OnPrint directly from console thread produces "unexpected async replies".
 485  */
 486 void firePrintEvent(wxString str, int status)
 487 {
 488    wxbPrintObject* po = new wxbPrintObject(str, status);
 489
 490    wxbThreadEvent evt(Thread);
 491    evt.SetEventPrintObject(po);
 492
 493    wxbMainFrame::GetInstance()->AddPendingEvent(evt);
 494 }
 495
 496 //wxString csBuffer; /* Temporary buffer for receiving data from console thread */
 497
 498 /*
 499  *  Called by console thread, this function forwards data line by line and end
 500  *  signals to the GUI.
 501  */
 502 void csprint(const char* str, int status)
 503 {
 504    if (str != 0) {
 505       firePrintEvent(wxString(str), status);
 506    }
 507    else {
 508       firePrintEvent("", status);
 509    }
 510 }
 511