5 * Nicolas Boichat, July 2004
10 Copyright (C) 2004 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License
14 as published by the Free Software Foundation; either version 2
15 of the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #include "wxbmainframe.h" // class's header file
29 #include "wxbrestorepanel.h"
31 #include "wxbconfigfileeditor.h"
35 #include "wxwin16x16.xpm"
37 #include <wx/arrimpl.cpp>
39 #include <wx/stattext.h>
40 #include <wx/statline.h>
41 #include <wx/config.h>
43 #include <wx/filename.h>
45 #undef Yield /* MinGW defines Yield */
47 // ----------------------------------------------------------------------------
48 // event tables and other macros for wxWindows
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
53 // ----------------------------------------------------------------------------
55 // IDs for the controls and the menu commands
61 // it is important for the id corresponding to the "About" command to have
62 // this standard value as otherwise it won't be handled properly under Mac
63 // (where it is special and put into the "Apple" menu)
64 Minimal_About = wxID_ABOUT,
76 * wxbTHREAD_EVENT declaration, used by csprint
78 BEGIN_DECLARE_EVENT_TYPES()
79 DECLARE_EVENT_TYPE(wxbTHREAD_EVENT, 1)
80 END_DECLARE_EVENT_TYPES()
82 DEFINE_EVENT_TYPE(wxbTHREAD_EVENT)
84 typedef void (wxEvtHandler::*wxThreadEventFunction)(wxbThreadEvent&);
86 #define EVT_THREAD_EVENT(id, fn) \
87 DECLARE_EVENT_TABLE_ENTRY( \
88 wxbTHREAD_EVENT, id, wxID_ANY, \
89 (wxObjectEventFunction)(wxEventFunction)(wxThreadEventFunction)&fn, \
93 // the event tables connect the wxWindows events with the functions (event
94 // handlers) which process them. It can be also done at run-time, but for the
95 // simple menu events like this the static method is much simpler.
96 BEGIN_EVENT_TABLE(wxbMainFrame, wxFrame)
97 EVT_MENU(Minimal_Quit, wxbMainFrame::OnQuit)
98 EVT_MENU(Minimal_About, wxbMainFrame::OnAbout)
99 EVT_MENU(ChangeConfigFile, wxbMainFrame::OnChangeConfig)
100 EVT_MENU(EditConfigFile, wxbMainFrame::OnEditConfig)
101 EVT_MENU(MenuConnect, wxbMainFrame::OnConnect)
102 EVT_MENU(MenuDisconnect, wxbMainFrame::OnDisconnect)
103 EVT_TEXT_ENTER(TypeText, wxbMainFrame::OnEnter)
104 EVT_THREAD_EVENT(Thread, wxbMainFrame::OnPrint)
105 EVT_BUTTON(SendButton, wxbMainFrame::OnEnter)
108 // ----------------------------------------------------------------------------
110 // ----------------------------------------------------------------------------
113 * wxbThreadEvent constructor
115 wxbThreadEvent::wxbThreadEvent(int id): wxEvent(id, wxbTHREAD_EVENT) {
116 m_eventObject = NULL;
120 * wxbThreadEvent destructor
122 wxbThreadEvent::~wxbThreadEvent()
124 if (m_eventObject != NULL) {
125 delete m_eventObject;
130 * wxbThreadEvent copy constructor
132 wxbThreadEvent::wxbThreadEvent(const wxbThreadEvent& te)
134 this->m_eventType = te.m_eventType;
135 this->m_id = te.m_id;
136 if (te.m_eventObject != NULL) {
137 this->m_eventObject = new wxbPrintObject(*((wxbPrintObject*)te.m_eventObject));
140 this->m_eventObject = NULL;
142 this->m_skipped = te.m_skipped;
143 this->m_timeStamp = te.m_timeStamp;
147 * Must be implemented (abstract in wxEvent)
149 wxEvent* wxbThreadEvent::Clone() const
151 return new wxbThreadEvent(*this);
155 * Gets the wxbPrintObject attached to this event, containing data sent by director
157 wxbPrintObject* wxbThreadEvent::GetEventPrintObject()
159 return (wxbPrintObject*)m_eventObject;
163 * Sets the wxbPrintObject attached to this event
165 void wxbThreadEvent::SetEventPrintObject(wxbPrintObject* object)
167 m_eventObject = (wxObject*)object;
170 // ----------------------------------------------------------------------------
172 // ----------------------------------------------------------------------------
174 wxbMainFrame *wxbMainFrame::frame = NULL;
177 * Singleton constructor
179 wxbMainFrame* wxbMainFrame::CreateInstance(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
181 frame = new wxbMainFrame(title, pos, size, style);
186 * Returns singleton instance
188 wxbMainFrame* wxbMainFrame::GetInstance()
196 wxbMainFrame::~wxbMainFrame()
198 if (ct != NULL) { // && (!ct->IsRunning())
205 * Private constructor
207 wxbMainFrame::wxbMainFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
208 : wxFrame(NULL, -1, title, pos, size, style)
210 lockedbyconsole = false;
216 // set the frame icon
217 SetIcon(wxIcon(wxwin16x16_xpm));
221 menuFile = new wxMenu;
223 // the "About" item should be in the help menu
224 wxMenu *helpMenu = new wxMenu;
225 helpMenu->Append(Minimal_About, _T("&About...\tF1"), _T("Show about dialog"));
227 menuFile->Append(MenuConnect, _T("Connect"), _T("Connect to the director"));
228 menuFile->Append(MenuDisconnect, _T("Disconnect"), _T("Disconnect of the director"));
229 menuFile->AppendSeparator();
230 menuFile->Append(ChangeConfigFile, _T("Change of configuration file"), _T("Change your default configuration file"));
231 menuFile->Append(EditConfigFile, _T("Edit your configuration file"), _T("Edit your configuration file"));
232 menuFile->AppendSeparator();
233 menuFile->Append(Minimal_Quit, _T("E&xit\tAlt-X"), _T("Quit this program"));
235 // now append the freshly created menu to the menu bar...
236 wxMenuBar *menuBar = new wxMenuBar();
237 menuBar->Append(menuFile, _T("&File"));
238 menuBar->Append(helpMenu, _T("&Help"));
240 // ... and attach this menu bar to the frame
242 #endif // wxUSE_MENUS
245 SetStatusText(wxString("Welcome to bacula wx-console ") << VERSION << " (" << BDATE << ")!\n");
247 wxPanel* global = new wxPanel(this, -1);
249 notebook = new wxNotebook(global, -1);
253 wxPanel* consolePanel = new wxPanel(notebook, -1);
254 notebook->AddPage(consolePanel, "Console");
256 consoleCtrl = new wxTextCtrl(consolePanel,-1,"",wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE | wxTE_READONLY | wxTE_RICH);
257 wxFont font(10, wxMODERN, wxNORMAL, wxNORMAL);
258 #if defined __WXGTK12__ && !defined __WXGTK20__ // Fix for "chinese" fonts under gtk+ 1.2
259 font.SetDefaultEncoding(wxFONTENCODING_ISO8859_1);
260 consoleCtrl->SetDefaultStyle(wxTextAttr(*wxBLACK, wxNullColour, font));
261 Print("Warning : Unicode is disabled because you are using wxWidgets for GTK+ 1.2.\n", CS_DEBUG);
263 consoleCtrl->SetDefaultStyle(wxTextAttr(*wxBLACK, wxNullColour, font));
266 helpCtrl = new wxStaticText(consolePanel, -1, "Type your command below:");
268 wxFlexGridSizer *consoleSizer = new wxFlexGridSizer(4, 1, 0, 0);
269 consoleSizer->AddGrowableCol(0);
270 consoleSizer->AddGrowableRow(0);
272 typeCtrl = new wxbHistoryTextCtrl(helpCtrl, consolePanel,TypeText,"",wxDefaultPosition,wxSize(200,20));
273 sendButton = new wxButton(consolePanel, SendButton, "Send");
275 wxFlexGridSizer *typeSizer = new wxFlexGridSizer(1, 2, 0, 0);
276 typeSizer->AddGrowableCol(0);
277 typeSizer->AddGrowableRow(0);
279 //typeSizer->Add(new wxStaticText(consolePanel, -1, "Command: "), 0, wxALIGN_CENTER | wxALL, 0);
280 typeSizer->Add(typeCtrl, 1, wxEXPAND | wxALL, 0);
281 typeSizer->Add(sendButton, 1, wxEXPAND | wxLEFT, 5);
283 consoleSizer->Add(consoleCtrl, 1, wxEXPAND | wxALL, 0);
284 consoleSizer->Add(new wxStaticLine(consolePanel, -1), 0, wxEXPAND | wxALL, 0);
285 consoleSizer->Add(helpCtrl, 1, wxEXPAND | wxALL, 2);
286 consoleSizer->Add(typeSizer, 0, wxEXPAND | wxALL, 2);
288 consolePanel->SetAutoLayout( TRUE );
289 consolePanel->SetSizer( consoleSizer );
290 consoleSizer->SetSizeHints( consolePanel );
292 // Creates the list of panels which are included in notebook, and that need to receive director information
294 panels = new wxbPanel* [2];
295 panels[0] = new wxbRestorePanel(notebook);
298 for (int i = 0; panels[i] != NULL; i++) {
299 notebook->AddPage(panels[i], panels[i]->GetTitle());
302 wxBoxSizer* globalSizer = new wxBoxSizer(wxHORIZONTAL);
304 globalSizer->Add(new wxNotebookSizer(notebook), 1, wxEXPAND, 0);
306 global->SetSizer( globalSizer );
307 globalSizer->SetSizeHints( global );
309 wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
311 sizer->Add(global, 1, wxEXPAND | wxALL, 0);
314 sizer->SetSizeHints( this );
316 EnableConsole(false);
324 * Starts the thread interacting with the director
325 * If config is not empty, uses this config file.
327 void wxbMainFrame::StartConsoleThread(const wxString& config) {
328 menuFile->Enable(MenuConnect, false);
329 menuFile->Enable(MenuDisconnect, false);
330 menuFile->Enable(ChangeConfigFile, false);
331 menuFile->Enable(EditConfigFile, false);
338 if (promptparser == NULL) {
339 promptparser = new wxbPromptParser();
345 if (((wxTheApp->argc % 2) != 1)) {
346 Print("Error while parsing command line arguments, using defaults.\n", CS_DEBUG);
347 Print("Usage: wx-console [-c configfile] [-w tmp]\n", CS_DEBUG);
350 for (int c = 1; c < wxTheApp->argc; c += 2) {
351 if ((wxTheApp->argc >= c+2) && (wxString(wxTheApp->argv[c]) == "-c")) {
352 configfile = wxTheApp->argv[c+1];
354 if ((wxTheApp->argc >= c+2) && (wxString(wxTheApp->argv[c]) == "-w")) {
355 console_thread::SetWorkingDirectory(wxTheApp->argv[c+1]);
357 if (wxTheApp->argv[c][0] != '-') {
358 Print("Error while parsing command line arguments, using defaults.\n", CS_DEBUG);
359 Print("Usage: wx-console [-c configfile] [-w tmp]\n", CS_DEBUG);
365 if (configfile == "") {
366 wxConfig::Set(new wxConfig("wx-console", "bacula"));
367 if (!wxConfig::Get()->Read("/ConfigFile", &configfile)) {
369 wxFileName filename(::wxGetHomeDir());
370 filename.MakeAbsolute();
371 configfile = filename.GetLongPath();
372 if (configfile.Last() != '/')
374 configfile += "Library/Preferences/org.bacula.wxconsole.conf";
376 wxFileName filename(::wxGetCwd(), "wx-console.conf");
377 filename.MakeAbsolute();
378 configfile = filename.GetLongPath();
380 configfile.Replace("\\", "/");
383 wxConfig::Get()->Write("/ConfigFile", configfile);
385 int answer = wxMessageBox(
386 wxString("It seems that it is the first time you run wx-console.\n") <<
387 "This file (" << configfile << ") has been choosen as default configuration file.\n" <<
388 "Do you want to edit it? (if you click No you will have to select another file)",
390 wxYES_NO | wxICON_QUESTION, this);
391 if (answer == wxYES) {
392 wxbConfigFileEditor(this, configfile).ShowModal();
401 wxString err = console_thread::LoadConfig(configfile);
404 int answer = wxMessageBox(
405 wxString("Unable to read ") << configfile << "\n" <<
406 err << "\nDo you want to choose another one? (Press no to edit this file)",
407 "Unable to read configuration file",
408 wxYES_NO | wxCANCEL | wxICON_ERROR, this);
409 if (answer == wxNO) {
410 wxbConfigFileEditor(this, configfile).ShowModal();
411 err = console_thread::LoadConfig(configfile);
413 else if (answer == wxCANCEL) {
418 else { // (answer == wxYES)
419 configfile = wxFileSelector("Please choose a configuration file to use");
420 if ( !configfile.empty() ) {
421 err = console_thread::LoadConfig(configfile);
430 if ((err == "") && (config == "")) {
431 answer = wxMessageBox(
432 "This configuration file has been successfully read, use it as default?",
433 "Configuration file read successfully",
434 wxYES_NO | wxICON_QUESTION, this);
435 if (answer == wxYES) {
436 wxConfigBase::Get()->Write("/ConfigFile", configfile);
442 csprint(wxString("Using this configuration file: ") << configfile << "\n", CS_DEBUG);
444 ct = new console_thread();
447 SetStatusText("Connecting to the director...");
450 /* Register a new wxbDataParser */
451 void wxbMainFrame::Register(wxbDataParser* dp) {
455 /* Unregister a wxbDataParser */
456 void wxbMainFrame::Unregister(wxbDataParser* dp) {
458 if ((index = parsers.Index(dp)) != wxNOT_FOUND) {
459 parsers.RemoveAt(index);
462 Print("Failed to unregister a data parser !", CS_DEBUG);
468 void wxbMainFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
470 Print("Quitting.\n", CS_DEBUG);
476 console_thread::FreeLib();
482 void wxbMainFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
485 msg.Printf( _T("Welcome to Bacula wx-console.\nWritten by Nicolas Boichat <nicolas@boichat.ch>\n(C) 2004 Kern Sibbald and John Walker\n"));
487 wxMessageBox(msg, _T("About Bacula wx-console"), wxOK | wxICON_INFORMATION, this);
490 void wxbMainFrame::OnChangeConfig(wxCommandEvent& event) {
491 wxString oriconfigfile;
492 wxConfig::Get()->Read("/ConfigFile", &oriconfigfile);
493 wxString configfile = wxFileSelector("Please choose your default configuration file");
494 if ( !configfile.empty() ) {
495 if (oriconfigfile != configfile) {
496 int answer = wxMessageBox(
497 "Use this configuration file as default?",
498 "Configuration file",
499 wxYES_NO | wxICON_QUESTION, this);
500 if (answer == wxYES) {
501 wxConfigBase::Get()->Write("/ConfigFile", configfile);
502 wxConfigBase::Get()->Flush();
503 StartConsoleThread("");
508 StartConsoleThread(configfile);
512 void wxbMainFrame::OnEditConfig(wxCommandEvent& event) {
514 wxConfig::Get()->Read("/ConfigFile", &configfile);
515 int stat = wxbConfigFileEditor(this, configfile).ShowModal();
517 StartConsoleThread(configfile);
521 void wxbMainFrame::OnConnect(wxCommandEvent& event) {
522 StartConsoleThread(configfile);
525 void wxbMainFrame::OnDisconnect(wxCommandEvent& event) {
532 void wxbMainFrame::OnEnter(wxCommandEvent& WXUNUSED(event))
534 lockedbyconsole = true;
536 typeCtrl->HistoryAdd(typeCtrl->GetValue());
537 wxString str = typeCtrl->GetValue() + "\n";
542 * Called when data is arriving from director
544 void wxbMainFrame::OnPrint(wxbThreadEvent& event) {
545 wxbPrintObject* po = event.GetEventPrintObject();
547 Print(po->str, po->status);
551 * Prints data received from director to the console, and forwards it to the panels
553 void wxbMainFrame::Print(wxString str, int status)
555 if (lockedbyconsole) {
556 EnableConsole(false);
559 if (status == CS_TERMINATED) {
560 consoleCtrl->AppendText(consoleBuffer);
562 SetStatusText("Console thread terminated.");
563 consoleCtrl->ScrollLines(3);
566 int answer = wxMessageBox("Connection to the director lost. Quit program?", "Connection lost",
567 wxYES_NO | wxICON_EXCLAMATION, this);
568 if (answer == wxYES) {
572 menuFile->Enable(MenuConnect, true);
573 menuFile->SetLabel(MenuConnect, "Connect");
574 menuFile->SetHelpString(MenuConnect, "Connect to the director");
575 menuFile->Enable(MenuDisconnect, false);
576 menuFile->Enable(ChangeConfigFile, true);
577 menuFile->Enable(EditConfigFile, true);
581 if (status == CS_CONNECTED) {
582 SetStatusText("Connected to the director.");
583 typeCtrl->ClearCommandList();
584 wxbDataTokenizer* dt = wxbUtils::WaitForEnd(".help", true);
587 for (i = 0; i < (int)dt->GetCount(); i++) {
590 if ((j = str.Find(' ')) > -1) {
591 typeCtrl->AddCommand(str.Mid(0, j), str.Mid(j+1));
595 menuFile->Enable(MenuConnect, true);
596 menuFile->SetLabel(MenuConnect, "Reconnect");
597 menuFile->SetHelpString(MenuConnect, "Reconnect to the director");
598 menuFile->Enable(MenuDisconnect, true);
599 menuFile->Enable(ChangeConfigFile, true);
600 menuFile->Enable(EditConfigFile, true);
603 if (status == CS_DISCONNECTED) {
604 consoleCtrl->AppendText(consoleBuffer);
606 consoleCtrl->ScrollLines(3);
607 SetStatusText("Disconnected of the director.");
612 // CS_DEBUG is often sent by panels,
613 // and resend it to them would sometimes cause infinite loops
615 /* One promptcaught is normal, so we must have two true Print values to be
616 * sure that the prompt has effectively been caught.
618 int promptcaught = -1;
620 if (status != CS_DEBUG) {
621 for (unsigned int i = 0; i < parsers.GetCount(); i++) {
622 promptcaught += parsers[i]->Print(str, status) ? 1 : 0;
625 if ((status == CS_PROMPT) && (promptcaught < 1) && (promptparser->isPrompt())) {
626 Print("Unexpected question has been received.\n", CS_DEBUG);
627 // Print(wxString("(") << promptparser->getIntroString() << "/-/" << promptparser->getQuestionString() << ")\n", CS_DEBUG);
630 if (promptparser->getIntroString() != "") {
631 message << promptparser->getIntroString() << "\n";
633 message << promptparser->getQuestionString();
635 if (promptparser->getChoices()) {
636 wxString *choices = new wxString[promptparser->getChoices()->GetCount()];
637 int *numbers = new int[promptparser->getChoices()->GetCount()];
640 for (unsigned int i = 0; i < promptparser->getChoices()->GetCount(); i++) {
641 if ((*promptparser->getChoices())[i] != "") {
642 choices[n] = (*promptparser->getChoices())[i];
648 int res = ::wxGetSingleChoiceIndex(message,
649 "wx-console: unexpected director's question.", n, choices, this);
650 if (res == -1) { //Cancel pressed
654 if (promptparser->isNumericalChoice()) {
655 Send(wxString() << numbers[res] << "\n");
658 Send(wxString() << choices[res] << "\n");
663 Send(::wxGetTextFromUser(message,
664 "wx-console: unexpected director's question.", "", this) + "\n");
669 if (status == CS_END) {
670 if (lockedbyconsole) {
672 lockedbyconsole = false;
677 if (status == CS_DEBUG) {
678 consoleCtrl->AppendText(consoleBuffer);
680 consoleCtrl->ScrollLines(3);
681 consoleCtrl->SetDefaultStyle(wxTextAttr(wxColour(0, 128, 0)));
684 consoleCtrl->SetDefaultStyle(wxTextAttr(*wxBLACK));
686 consoleBuffer << str;
687 if (status == CS_PROMPT) {
688 if (lockedbyconsole) {
691 //consoleBuffer << "<P>";
694 if ((status == CS_END) || (status == CS_PROMPT) || (str.Find("\n") > -1)) {
695 consoleCtrl->AppendText(consoleBuffer);
698 consoleCtrl->ScrollLines(3);
701 // consoleCtrl->ShowPosition(consoleCtrl->GetLastPosition());
703 /*if (status != CS_DEBUG) {
704 consoleCtrl->AppendText("@");
706 //consoleCtrl->SetInsertionPointEnd();
708 /* if ((consoleCtrl->GetNumberOfLines()-1) > nlines) {
709 nlines = consoleCtrl->GetNumberOfLines()-1;
712 if (status == CS_END) {
713 consoleCtrl->ShowPosition(nlines);
718 * Sends data to the director
720 void wxbMainFrame::Send(wxString str)
723 ct->Write((const char*)str);
724 typeCtrl->SetValue("");
725 consoleCtrl->SetDefaultStyle(wxTextAttr(*wxRED));
726 consoleCtrl->AppendText(str);
727 consoleCtrl->ScrollLines(3);
730 /* if ((consoleCtrl->GetNumberOfLines()-1) > nlines) {
731 nlines = consoleCtrl->GetNumberOfLines()-1;
734 consoleCtrl->ShowPosition(nlines);*/
738 void wxbMainFrame::EnablePanels() {
739 for (int i = 0; panels[i] != NULL; i++) {
740 panels[i]->EnablePanel(true);
745 /* Disable panels, except the one passed as parameter */
746 void wxbMainFrame::DisablePanels(void* except) {
747 for (int i = 0; panels[i] != NULL; i++) {
748 if (panels[i] != except) {
749 panels[i]->EnablePanel(false);
752 panels[i]->EnablePanel(true);
755 if (this != except) {
756 EnableConsole(false);
760 /* Enable or disable console typing */
761 void wxbMainFrame::EnableConsole(bool enable) {
762 typeCtrl->Enable(enable);
763 sendButton->Enable(enable);
765 typeCtrl->SetFocus();
770 * Used by csprint, which is called by console thread.
772 * In GTK and perhaps X11, only the main thread is allowed to interact with
773 * graphical components, so by firing an event, the main loop will call OnPrint.
775 * Calling OnPrint directly from console thread produces "unexpected async replies".
777 void firePrintEvent(wxString str, int status)
779 wxbPrintObject* po = new wxbPrintObject(str, status);
781 wxbThreadEvent evt(Thread);
782 evt.SetEventPrintObject(po);
784 if (wxbMainFrame::GetInstance()) {
785 wxbMainFrame::GetInstance()->AddPendingEvent(evt);
789 //wxString csBuffer; /* Temporary buffer for receiving data from console thread */
792 * Called by console thread, this function forwards data line by line and end
793 * signals to the GUI.
795 void csprint(const char* str, int status)
798 firePrintEvent(wxString(str), status);
801 firePrintEvent("", status);