2 Bacula® - The Network Backup Solution
4 Copyright (C) 2007-2010 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * DirComm, Director communications,class
31 * Kern Sibbald, January MMVII
39 #include "textinput.h"
42 static int tls_pem_callback(char *buf, int size, const void *userdata);
44 DirComm::DirComm(Console *parent, int conn): m_notifier(NULL), m_api_set(false)
49 m_at_main_prompt = false;
59 /* Terminate any open socket */
60 void DirComm::terminate()
64 m_notifier->setEnabled(false);
68 if (mainWin->m_connDebug)
69 Pmsg2(000, "DirComm %i terminating connections %s\n", m_conn, m_console->m_dir->name());
76 * Connect to Director.
78 bool DirComm::connect_dir()
88 mainWin->set_status( tr("Already connected."));
89 m_console->display_textf(_("Already connected\"%s\".\n"),
90 m_console->m_dir->name());
91 if (mainWin->m_connDebug) {
92 Pmsg2(000, "DirComm %i BAILING already connected %s\n", m_conn, m_console->m_dir->name());
97 if (mainWin->m_connDebug)Pmsg2(000, "DirComm %i connecting %s\n", m_conn, m_console->m_dir->name());
98 memset(jcr, 0, sizeof(JCR));
100 mainWin->set_statusf(_("Connecting to Director %s:%d"), m_console->m_dir->address, m_console->m_dir->DIRport);
102 m_console->display_textf(_("Connecting to Director %s:%d\n\n"), m_console->m_dir->address, m_console->m_dir->DIRport);
105 /* Give GUI a chance */
106 app->processEvents();
109 /* If cons==NULL, default console will be used */
110 cons = (CONRES *)GetNextRes(R_CONSOLE, NULL);
113 /* Initialize Console TLS context once */
114 if (cons && !cons->tls_ctx && (cons->tls_enable || cons->tls_require)) {
115 /* Generate passphrase prompt */
116 bsnprintf(buf, sizeof(buf), "Passphrase for Console \"%s\" TLS private key: ",
119 /* Initialize TLS context:
120 * Args: CA certfile, CA certdir, Certfile, Keyfile,
121 * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer
123 cons->tls_ctx = new_tls_context(cons->tls_ca_certfile,
124 cons->tls_ca_certdir, cons->tls_certfile,
125 cons->tls_keyfile, tls_pem_callback, &buf, NULL, true);
127 if (!cons->tls_ctx) {
128 m_console->display_textf(_("Failed to initialize TLS context for Console \"%s\".\n"),
129 m_console->m_dir->name());
130 if (mainWin->m_connDebug) {
131 Pmsg2(000, "DirComm %i BAILING Failed to initialize TLS context for Console %s\n", m_conn, m_console->m_dir->name());
137 /* Initialize Director TLS context once */
138 if (!m_console->m_dir->tls_ctx && (m_console->m_dir->tls_enable || m_console->m_dir->tls_require)) {
139 /* Generate passphrase prompt */
140 bsnprintf(buf, sizeof(buf), "Passphrase for Director \"%s\" TLS private key: ",
141 m_console->m_dir->name());
143 /* Initialize TLS context:
144 * Args: CA certfile, CA certdir, Certfile, Keyfile,
145 * Keyfile PEM Callback, Keyfile CB Userdata, DHfile, Verify Peer */
146 m_console->m_dir->tls_ctx = new_tls_context(m_console->m_dir->tls_ca_certfile,
147 m_console->m_dir->tls_ca_certdir, m_console->m_dir->tls_certfile,
148 m_console->m_dir->tls_keyfile, tls_pem_callback, &buf, NULL, true);
150 if (!m_console->m_dir->tls_ctx) {
151 m_console->display_textf(_("Failed to initialize TLS context for Director \"%s\".\n"),
152 m_console->m_dir->name());
153 mainWin->set_status("Connection failed");
154 if (mainWin->m_connDebug) {
155 Pmsg2(000, "DirComm %i BAILING Failed to initialize TLS context for Director %s\n", m_conn, m_console->m_dir->name());
161 if (m_console->m_dir->heartbeat_interval) {
162 heart_beat = m_console->m_dir->heartbeat_interval;
164 heart_beat = cons->heartbeat_interval;
169 m_sock = bnet_connect(NULL, 5, 15, heart_beat,
170 _("Director daemon"), m_console->m_dir->address,
171 NULL, m_console->m_dir->DIRport, 0);
172 if (m_sock == NULL) {
173 mainWin->set_status("Connection failed");
174 if (mainWin->m_connDebug) {
175 Pmsg2(000, "DirComm %i BAILING Connection failed %s\n", m_conn, m_console->m_dir->name());
179 /* Update page selector to green to indicate that Console is connected */
180 mainWin->actionConnect->setIcon(QIcon(":images/connected.png"));
181 QBrush greenBrush(Qt::green);
182 QTreeWidgetItem *item = mainWin->getFromHash(m_console);
184 item->setForeground(0, greenBrush);
188 jcr->dir_bsock = m_sock;
190 if (!authenticate_director(jcr, m_console->m_dir, cons, buf, sizeof(buf))) {
191 m_console->display_text(buf);
192 if (mainWin->m_connDebug) {
193 Pmsg2(000, "DirComm %i BAILING Connection failed %s\n", m_conn, m_console->m_dir->name());
199 m_console->display_text(buf);
202 /* Give GUI a chance */
203 app->processEvents();
205 mainWin->set_status(_("Initializing ..."));
208 * Set up input notifier
210 m_notifier = new QSocketNotifier(m_sock->m_fd, QSocketNotifier::Read, 0);
211 QObject::connect(m_notifier, SIGNAL(activated(int)), this, SLOT(notify_read_dir(int)));
212 m_notifier->setEnabled(true);
216 m_console->displayToPrompt(m_conn);
218 m_console->beginNewCommand(m_conn);
220 mainWin->set_status(_("Connected"));
222 if (mainWin->m_connDebug) {
223 Pmsg2(000, "Returning TRUE from DirComm->connect_dir : %i %s\n", m_conn, m_console->m_dir->name());
228 if (mainWin->m_connDebug) {
229 Pmsg2(000, "Returning FALSE from DirComm->connect_dir : %i %s\n", m_conn, m_console->m_dir->name());
236 * This should be moved into a bSocket class
246 int DirComm::write(const QString msg)
248 return write(msg.toUtf8().data());
251 int DirComm::write(const char *msg)
256 m_sock->msglen = pm_strcpy(m_sock->msg, msg);
258 m_at_main_prompt = false;
259 if (mainWin->m_commDebug) Pmsg2(000, "conn %i send: %s\n", m_conn, msg);
260 return m_sock->send();
263 int DirComm::sock_read()
267 bool wasEnabled = notify(false);
268 stat = m_sock->recv();
271 stat = m_sock->recv();
277 * Blocking read from director
289 stat = m_sock->wait_data_intr(0, 50000);
293 app->processEvents();
294 if (m_api_set && m_console->is_messagesPending() && is_notify_enabled() && m_console->hasFocus()) {
295 if (mainWin->m_commDebug) Pmsg1(000, "conn %i process_events\n", m_conn);
296 m_console->write_dir(m_conn, ".messages", false);
297 m_console->messagesPending(false);
306 if (mainWin->m_commDebug) Pmsg2(000, "conn %i got: %s\n", m_conn, m_sock->msg);
308 m_console->display_text("\n");
310 m_at_main_prompt = false;
313 switch (m_sock->msglen) {
314 case BNET_MSGS_PENDING :
315 if (is_notify_enabled() && m_console->hasFocus()) {
316 if (mainWin->m_commDebug) Pmsg1(000, "conn %i MSGS PENDING\n", m_conn);
317 m_console->write_dir(m_conn, ".messages", false);
318 m_console->displayToPrompt(m_conn);
319 m_console->messagesPending(false);
322 m_console->messagesPending(true);
325 if (mainWin->m_commDebug) Pmsg1(000, "conn %i CMD OK\n", m_conn);
327 m_at_main_prompt = false;
328 if (--m_in_command < 0) {
331 mainWin->set_status(_("Command completed ..."));
334 if (mainWin->m_commDebug) Pmsg1(000, "conn %i CMD BEGIN\n", m_conn);
336 m_at_main_prompt = false;
338 mainWin->set_status(_("Processing command ..."));
340 case BNET_MAIN_PROMPT:
341 if (mainWin->m_commDebug) Pmsg1(000, "conn %i MAIN PROMPT\n", m_conn);
342 if (!m_at_prompt && ! m_at_main_prompt) {
344 m_at_main_prompt = true;
345 mainWin->set_status(_("At main prompt waiting for input ..."));
348 case BNET_SUB_PROMPT:
349 if (mainWin->m_commDebug) Pmsg2(000, "conn %i SUB_PROMPT m_in_select=%d\n", m_conn, m_in_select);
351 m_at_main_prompt = false;
352 mainWin->set_status(_("At prompt waiting for input ..."));
354 case BNET_TEXT_INPUT:
355 if (mainWin->m_commDebug) Pmsg4(000, "conn %i TEXT_INPUT at_prompt=%d m_in_select=%d notify=%d\n",
356 m_conn, m_at_prompt, m_in_select, is_notify_enabled());
357 if (!m_in_select && is_notify_enabled()) {
359 new textInputDialog(m_console, m_conn);
361 if (mainWin->m_commDebug) Pmsg0(000, "!m_in_select && is_notify_enabled\n");
363 m_at_main_prompt = false;
364 mainWin->set_status(_("At prompt waiting for input ..."));
367 case BNET_CMD_FAILED:
368 if (mainWin->m_commDebug) Pmsg1(000, "CMD FAILED\n", m_conn);
369 if (--m_in_command < 0) {
372 mainWin->set_status(_("Command failed."));
374 /* We should not get this one */
376 if (mainWin->m_commDebug) Pmsg1(000, "conn %i EOD\n", m_conn);
377 mainWin->set_status_ready();
382 case BNET_START_SELECT:
383 if (mainWin->m_commDebug) Pmsg1(000, "conn %i START SELECT\n", m_conn);
385 new selectDialog(m_console, m_conn);
389 if (mainWin->m_commDebug) Pmsg1(000, "conn %i YESNO\n", m_conn);
390 new yesnoPopUp(m_console, m_conn);
393 if (mainWin->m_commDebug) Pmsg1(000, "conn %i RUN CMD\n", m_conn);
394 new runCmdPage(m_conn);
396 case BNET_START_RTREE:
397 if (mainWin->m_commDebug) Pmsg1(000, "conn %i START RTREE CMD\n", m_conn);
398 new restorePage(m_conn);
401 if (mainWin->m_commDebug) Pmsg1(000, "conn %i END RTREE CMD\n", m_conn);
404 if (mainWin->m_commDebug) Pmsg1(000, "conn %i ERROR MSG\n", m_conn);
405 stat = sock_read(); /* get the message */
406 m_console->display_text(msg());
407 QMessageBox::critical(m_console, "Error", msg(), QMessageBox::Ok);
408 m_console->beginNewCommand(m_conn);
411 case BNET_WARNING_MSG:
412 if (mainWin->m_commDebug) Pmsg1(000, "conn %i WARNING MSG\n", m_conn);
413 stat = sock_read(); /* get the message */
414 if (!m_console->m_warningPrevent) {
415 QMessageBox::critical(m_console, "Warning", msg(), QMessageBox::Ok);
419 if (mainWin->m_commDebug) Pmsg1(000, "conn %i INFO MSG\n", m_conn);
420 stat = sock_read(); /* get the message */
421 m_console->display_text(msg());
422 mainWin->set_status(msg());
430 if (is_bnet_stop(m_sock)) { /* error or term request */
431 if (mainWin->m_commDebug) Pmsg1(000, "conn %i BNET STOP\n", m_conn);
432 m_console->stopTimer();
435 mainWin->actionConnect->setIcon(QIcon(":images/disconnected.png"));
436 QBrush redBrush(Qt::red);
437 QTreeWidgetItem *item = mainWin->getFromHash(m_console);
438 item->setForeground(0, redBrush);
440 m_notifier->setEnabled(false);
444 mainWin->set_status(_("Director disconnected."));
452 /* Called by signal when the Director has output for us */
453 void DirComm::notify_read_dir(int /* fd */)
456 if (!mainWin->m_notify) {
459 if (mainWin->m_commDebug) Pmsg1(000, "enter read_dir conn %i read_dir\n", m_conn);
460 stat = m_sock->wait_data(0, 5000);
462 if (mainWin->m_commDebug) Pmsg2(000, "read_dir conn %i stat=%d\n", m_conn, stat);
463 while (read() >= 0) {
464 m_console->display_text(msg());
467 if (mainWin->m_commDebug) Pmsg2(000, "exit read_dir conn %i stat=%d\n", m_conn, stat);
471 * When the notifier is enabled, read_dir() will automatically be
472 * called by the Qt event loop when ever there is any output
473 * from the Director, and read_dir() will then display it on
476 * When we are in a bat dialog, we want to control *all* output
477 * from the Directory, so we set notify to off.
478 * m_console->notifiy(false);
480 bool DirComm::notify(bool enable)
482 bool prev_enabled = false;
483 /* Set global flag */
484 mainWin->m_notify = enable;
486 prev_enabled = m_notifier->isEnabled();
487 if (prev_enabled != enable) {
488 m_notifier->setEnabled(enable);
490 if (mainWin->m_connDebug) Pmsg3(000, "conn=%i notify=%d prev=%d\n", m_conn, enable, prev_enabled);
491 } else if (mainWin->m_connDebug) {
492 Pmsg2(000, "m_notifier does not exist: %i %s\n", m_conn, m_console->m_dir->name());
497 bool DirComm::is_notify_enabled() const
499 return mainWin->m_notify;
503 * Call-back for reading a passphrase for an encrypted PEM file
504 * This function uses getpass(),
505 * which uses a static buffer and is NOT thread-safe.
507 static int tls_pem_callback(char *buf, int size, const void *userdata)
512 # if defined(HAVE_WIN32)
514 if (win32_cgets(buf, size) == NULL) {
521 const char *prompt = (const char *)userdata;
524 passwd = getpass(prompt);
525 bstrncpy(buf, passwd, size);