applicationForm.cpp

   1 /*
   2     Copyright (C) 2013-2024 Ben Kibbey <bjk@luxsci.net>
   3
   4     This file is part of qpwmc.
   5
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Lesser General Public
   8     License as published by the Free Software Foundation; either
   9     version 2.1 of the License, or (at your option) any later version.
  10
  11     This library is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     Lesser General Public License for more details.
  15
  16     You should have received a copy of the GNU Lesser General Public
  17     License along with this library; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  19     USA
  20 */
  21 #include <QButtonGroup>
  22 #include <QPushButton>
  23 #include <QLineEdit>
  24 #include <QSpinBox>
  25 #include <QMessageBox>
  26 #include <QCalendarWidget>
  27
  28 #include "pwmdMainWindow.h"
  29 #include "pwmdSocketDialog.h"
  30 #include "applicationForm.h"
  31 #include "applicationFormXmlStream.h"
  32 #include "applicationFormRadioButton.h"
  33 #include "applicationFormPage.h"
  34 #include "applicationFormFileSelector.h"
  35 #include "applicationFormFinalizePage.h"
  36 #include "applicationFormGeneratePassword.h"
  37 #include "applicationFormExpiryButton.h"
  38 #include "applicationFormDateSelector.h"
  39 #include "pwmdExpireDialog.h"
  40
  41 ApplicationForm::ApplicationForm (Pwmd *pwmHandle, const QString &filename,
  42                                   PwmdTreeWidget *w, PwmdMainWindow *p)
  43      : QWizard ()
  44 {
  45   parent = p;
  46   elementTree = w;
  47   _modified = false;
  48   QAbstractButton *pb = button (QWizard::CancelButton);
  49   connect (pb, SIGNAL (clicked (bool)), this, SLOT (slotCancel (bool)));
  50   if (elementTree)
  51     {
  52       connect (elementTree,
  53                SIGNAL (currentItemChanged (QTreeWidgetItem *, QTreeWidgetItem *)),
  54                this,
  55                SLOT (slotFormElementSelected (QTreeWidgetItem *, QTreeWidgetItem *)));
  56     }
  57
  58   pwm = pwmHandle;
  59   doForm (filename);
  60 }
  61
  62 void
  63 ApplicationForm::setModified ()
  64 {
  65   _modified = true;
  66 }
  67
  68 bool
  69 ApplicationForm::modified ()
  70 {
  71   return _modified;
  72 }
  73
  74 void
  75 ApplicationForm::slotCancel (bool)
  76 {
  77   setHasError ();
  78 }
  79
  80 ApplicationForm::ApplicationForm (const QString &filename,
  81                                   QString socket, QString dataFilename,
  82                                   QString path) : QWizard ()
  83 {
  84   QAbstractButton *pb = button (QWizard::CancelButton);
  85   connect (pb, SIGNAL (clicked (bool)), this, SLOT (slotCancel (bool)));
  86   elementTree = nullptr;
  87   parent = nullptr;
  88   pwm = nullptr;
  89   _socket = socket;
  90   _dataFilename = dataFilename;
  91   _elementPath = path;
  92   doForm (filename);
  93 }
  94
  95 ApplicationForm::ApplicationForm (const QString &filename) : QWizard ()
  96 {
  97   QAbstractButton *pb = button (QWizard::CancelButton);
  98   connect (pb, SIGNAL (clicked (bool)), this, SLOT (slotCancel (bool)));
  99   parent = nullptr;
 100   elementTree = nullptr;
 101   pwm = nullptr;
 102   doForm (filename);
 103 }
 104
 105 void
 106 ApplicationForm::slotAccepted ()
 107 {
 108 }
 109
 110 void
 111 ApplicationForm::slotFormElementSelected (QTreeWidgetItem * item,
 112                                           QTreeWidgetItem * old)
 113 {
 114   (void)old;
 115   foreach (ApplicationFormWidget *w, stream->widgets ())
 116     {
 117       if (w->id () == "pwmdRootElement")
 118         {
 119           w->setValue (parent->elementPath (item, "<TAB>"));
 120           break;
 121         }
 122     }
 123 }
 124
 125 void
 126 ApplicationForm::addFormRow (QFormLayout *fl, QHBoxLayout *hb,
 127                              ApplicationFormWidget *w, QWizardPage *wp,
 128                              bool withLabel)
 129 {
 130   if (w->isRequired () && w->widget ())
 131     {
 132       connect (w->widget (), SIGNAL (textChanged (const QString &)), wp,
 133                SIGNAL (completeChanged ()));
 134     }
 135
 136   QLabel *l = new QLabel (w->label ());
 137   l->setWhatsThis (w->whatsThis ());
 138   widgetsToDelete.append (l);
 139
 140   if (hb)
 141     fl->addRow (withLabel ? l : 0, hb);
 142   else
 143     fl->addRow (withLabel ? l : 0, w->widget ());
 144 }
 145
 146 void
 147 ApplicationForm::setHasError (bool b)
 148 {
 149   _error = b;
 150 }
 151
 152 bool
 153 ApplicationForm::hasError ()
 154 {
 155   return _error;
 156 }
 157
 158 void
 159 ApplicationForm::slotPageChanged (int n)
 160 {
 161   if (n == 2)
 162     finalPage->commit ();
 163 }
 164
 165 void
 166 ApplicationForm::slotChangeExpiry ()
 167 {
 168   QWidget *fw = QApplication::focusWidget ();
 169   ApplicationFormExpiryButton *pb = static_cast<ApplicationFormExpiryButton*>(fw);
 170   ApplicationFormWidget *w = pb->formWidget ();
 171   PwmdExpireDialog *d = new PwmdExpireDialog (w->expiryDate (),
 172                                               w->expiryAge (), this);
 173
 174   if (d->exec ())
 175     w->setExpiry (d->expire (), d->increment ());
 176
 177   delete d;
 178 }
 179
 180 void
 181 ApplicationForm::addExpiry (ApplicationFormWidget *w, QHBoxLayout *hb)
 182 {
 183   if (hb && w && w->expiry ())
 184     {
 185       ApplicationFormExpiryButton *pb = new ApplicationFormExpiryButton (w);
 186
 187       pb->setIcon (QIcon (":icons/expiry.svg"));
 188       hb->addWidget (pb);
 189       connect (pb, SIGNAL (clicked ()), this, SLOT (slotChangeExpiry ()));
 190     }
 191 }
 192
 193 void
 194 ApplicationForm::slotDateSelector (const QDate &d)
 195 {
 196   foreach (ApplicationFormWidget *w, stream->widgets ())
 197     {
 198       if (w->dateSelector ())
 199         {
 200           ApplicationFormDateSelector *s = qobject_cast<ApplicationFormDateSelector *> (w->widget ());
 201           s->setDate (d);
 202         }
 203     }
 204 }
 205
 206 void
 207 ApplicationForm::doForm (const QString &filename)
 208 {
 209   setWindowFlags (Qt::WindowTitleHint);
 210   setWindowTitle (tr ("Pwmd Application Form"));
 211   ui.setupUi (this);
 212   stream = nullptr;
 213   _error = false;
 214   finalPage = nullptr;
 215   QRegularExpression rx ("^[!]?[^!\\s][^\\s]*");
 216   lineEditValidator = new QRegularExpressionValidator (rx, this);
 217
 218   connect (this, SIGNAL (currentIdChanged (int)), this, SLOT (slotPageChanged (int)));
 219   connect (this, SIGNAL (accepted ()), this, SLOT (slotAccepted ()));
 220
 221   stream = new ApplicationFormXmlStream (filename, this);
 222   if (stream->error () != QXmlStreamReader::NoError)
 223     {
 224       _error = true;
 225       return;
 226     }
 227
 228   QList<ApplicationFormWidget *> widgets = stream->widgets ();
 229   int radioButtonId = 0;
 230   ApplicationFormPage *wp = new ApplicationFormPage ();
 231   QFormLayout *fl = new QFormLayout (wp);
 232
 233   wp->setWidgets (widgets);
 234
 235   foreach (ApplicationFormWidget *w, widgets)
 236     {
 237       QHBoxLayout *hb = new QHBoxLayout ();
 238       bool withLabel = true;
 239
 240       if (w->type () == ApplicationFormWidget::AppWidgetRadioButton)
 241         {
 242           QButtonGroup *bg = new QButtonGroup ();
 243           QStringList rbs = w->radioButtons ();
 244
 245           widgetsToDelete.append (bg);
 246
 247           for (int n = 0; n < rbs.count (); n++)
 248             {
 249               ApplicationFormRadioButton *rb = new ApplicationFormRadioButton (rbs.at (n));
 250
 251               bg->addButton (rb);
 252               hb->addWidget (rb);
 253               rb->setId (radioButtonId);
 254               w->addRadioButtonId (radioButtonId++);
 255               connect (rb, SIGNAL (clicked (bool)), this,
 256                        SLOT (slotRadioButtonClicked (bool)));
 257
 258               if (w->value () == rbs.at (n))
 259                 rb->setChecked (true);
 260             }
 261         }
 262
 263       if (w->elementSelector ())
 264         {
 265           if (elementTree)
 266             {
 267               hb->addWidget (elementTree);
 268               addFormRow (fl, hb, w, wp, true);
 269               hb = new QHBoxLayout ();
 270               hb->addWidget (w->widget ());
 271               QLineEdit *le = static_cast <QLineEdit *> (w->widget ());
 272               le->setPlaceholderText (tr ("Enter or select from above..."));
 273               withLabel = false;
 274             }
 275           else
 276             {
 277               QPushButton *pb = new QPushButton ();
 278               pb->setText (tr ("Select"));
 279               hb->addWidget (w->widget ());
 280               hb->addWidget (pb);
 281               if (w->id () == "pwmdSocket")
 282                 connect (pb, SIGNAL (clicked ()), this,
 283                          SLOT (slotSocketSelector ()));
 284               else
 285                 connect (pb, SIGNAL (clicked ()), this,
 286                          SLOT (slotElementSelector ()));
 287             }
 288         }
 289       else if (w->dateSelector ())
 290         {
 291           QCalendarWidget *cal = new QCalendarWidget ();
 292           connect (cal, SIGNAL (clicked (const QDate &)), this,
 293                    SLOT (slotDateSelector (const QDate &)));
 294           hb->addWidget (cal);
 295           addFormRow (fl, hb, w, wp, true);
 296           hb = new QHBoxLayout ();
 297           hb->addWidget (w->widget ());
 298           ApplicationFormDateSelector *le = static_cast <ApplicationFormDateSelector*> (w->widget ());
 299           le->setText (w->value ());
 300           withLabel = false;
 301         }
 302       else if (w->fileSelector ())
 303         {
 304           ApplicationFormFileSelector *pb = new ApplicationFormFileSelector (w->widget (), this);
 305           pb->setText (tr ("Select"));
 306           hb->addWidget (w->widget ());
 307           hb->addWidget (pb);
 308           connect (pb, SIGNAL (clicked ()), pb, SLOT (slotFileSelector ()));
 309         }
 310       else if (w->passwordGenerator ())
 311         {
 312           ApplicationFormGeneratePassword *pb = new ApplicationFormGeneratePassword (w, this);
 313           pb->setText (tr ("Generate"));
 314           hb->addWidget (w->widget ());
 315           hb->addWidget (pb);
 316           connect (pb, SIGNAL (clicked ()), pb, SLOT (slotGeneratePassword ()));
 317         }
 318       else if (w->widget ())
 319         hb->addWidget (w->widget ());
 320
 321       if (w->type () == ApplicationFormWidget::AppWidgetLineEdit)
 322         {
 323           /* This QLineEdit creates an element from its value. Not a perfect
 324            *  RE, though. */
 325           if (w->pwmdName ().isEmpty ())
 326             {
 327               QLineEdit *le = static_cast<QLineEdit *>(w->widget ());
 328               le->setValidator (lineEditValidator);
 329             }
 330         }
 331
 332       addExpiry (w, hb);
 333       addFormRow (fl, hb, w, wp, withLabel);
 334     }
 335
 336   wp->setTitle (ui.wz_start->title ());
 337   wp->setSubTitle (ui.wz_start->subTitle ());
 338
 339   if (elementTree)
 340     slotFormElementSelected (elementTree->currentItem (), nullptr);
 341
 342   slotDateSelector (QDate::currentDate ());
 343   addPage (wp);
 344   finalPage = new ApplicationFormFinalizePage ();
 345   finalPage->setTitle (ui.wz_start->title ());
 346   finalPage->setSubTitle (ui.wz_start->subTitle ());
 347   finalPage->setHandle (pwm);
 348   updateForm (_dataFilename, _elementPath, _socket);
 349   addPage (finalPage);
 350 }
 351
 352 QString
 353 ApplicationForm::socket ()
 354 {
 355   QString s = QString ();
 356
 357   foreach (ApplicationFormWidget *w, stream->widgets ())
 358     {
 359       if (w->id () == "pwmdSocket")
 360         {
 361           QLineEdit *le = static_cast<QLineEdit *>(w->widget ());
 362
 363           w->setValue (le->text ());
 364           s = w->value ();
 365         }
 366     }
 367
 368   return s;
 369 }
 370
 371 QString
 372 ApplicationForm::filename ()
 373 {
 374   QString s = QString ();
 375
 376   foreach (ApplicationFormWidget *w, stream->widgets ())
 377     {
 378       if (w->id () == "pwmdFilename")
 379         {
 380           QLineEdit *le = static_cast<QLineEdit *>(w->widget ());
 381
 382           w->setValue (le->text ());
 383           s = w->value ();
 384         }
 385     }
 386
 387   return s;
 388 }
 389
 390 QString
 391 ApplicationForm::elementPath ()
 392 {
 393   QString s = QString ();
 394
 395   foreach (ApplicationFormWidget *w, stream->widgets ())
 396     {
 397       if (w->id () == "pwmdRootElement")
 398         s = w->value ();
 399     }
 400
 401   return s;
 402 }
 403
 404 void
 405 ApplicationForm::updateForm (QString filename, QString element, QString sock)
 406 {
 407   foreach (ApplicationFormWidget *w, stream->widgets ())
 408     {
 409       if (w->id () == "pwmdFilename" && !filename.isEmpty ())
 410         w->setValue (filename);
 411       else if (w->id () == "pwmdRootElement" && !element.isEmpty ())
 412         w->setValue (element.replace ("\t", "<TAB>"));
 413       else if (w->id () == "pwmdSocket" && !sock.isEmpty ())
 414         w->setValue (sock);
 415     }
 416 }
 417
 418 void
 419 ApplicationForm::keyPressEvent (QKeyEvent *ev)
 420 {
 421   if (ev->key () == Qt::Key_Escape)
 422     setHasError ();
 423
 424   QDialog::keyPressEvent (ev);
 425 }
 426
 427 void
 428 ApplicationForm::slotKnownHostCallback (void *data, const char *host,
 429                                         const char *key, size_t len)
 430 {
 431   gpg_error_t rc = Pwmd::knownHostPrompt (data, host, key, len);
 432   setHasError (rc != 0);
 433   emit knownHostRc (rc);
 434 }
 435
 436 void
 437 ApplicationForm::slotElementSelector ()
 438 {
 439   QString result;
 440   bool notFound = false;
 441   QString filename = buildElementPath (QString (), "pwmdFilename", notFound);
 442   QString rootElement = buildElementPath (QString (), "pwmdRootElement",
 443                                           notFound);
 444   QString sock = buildElementPath (QString (), "pwmdSocket", notFound);
 445   int n;
 446   bool ownHandle = false;
 447
 448   if (!pwm)
 449     {
 450       ownHandle =  true;
 451       pwm = new Pwmd (0, 0, 0, this);
 452       connect (pwm, SIGNAL (knownHost (void *, const char *, const char *, size_t)), this, SLOT (slotKnownHostCallback (void *, const char *, const char *, size_t)));
 453     }
 454
 455   if (pwm->spawnEditor (result, sock, filename, rootElement, false))
 456     {
 457       sock = Pwmd::extractToken (result, "<SOCKET>", n);
 458       filename = Pwmd::extractToken (result, "<FILE>", n);
 459       rootElement = Pwmd::extractToken (result, "<PATH>", n);
 460       updateForm (filename, rootElement, sock);
 461     }
 462
 463   if (ownHandle)
 464     {
 465       delete pwm;
 466       pwm = nullptr;
 467     }
 468 }
 469
 470 void
 471 ApplicationForm::slotSocketSelector ()
 472 {
 473   QString sock = QString ();
 474
 475   foreach (ApplicationFormWidget *w, stream->widgets ())
 476     {
 477       if (w->id () == "pwmdSocket")
 478         {
 479           sock = w->value ();
 480           break;
 481         }
 482     }
 483
 484   PwmdSocketDialog *d = new PwmdSocketDialog (sock, this);
 485   d->setParent (this, Qt::Dialog);
 486   if (d->exec ())
 487     updateForm (QString (), QString (), d->socket ());
 488
 489   delete d;
 490 }
 491
 492 void
 493 ApplicationForm::slotRadioButtonClicked (bool b)
 494 {
 495   (void)b;
 496   QWidget *fw = QApplication::focusWidget ();
 497   ApplicationFormRadioButton *rb = static_cast<ApplicationFormRadioButton *>(fw);
 498
 499   foreach (ApplicationFormWidget *w, stream->widgets ())
 500     {
 501       if (w->type () == ApplicationFormWidget::AppWidgetRadioButton)
 502         {
 503           if (w->hasRadioButtonId (rb->id ()))
 504             {
 505               w->setValue (rb->text ());
 506               return;
 507             }
 508         }
 509     }
 510 }
 511
 512 ApplicationForm::~ApplicationForm ()
 513 {
 514   if (stream)
 515     delete stream;
 516
 517   if (finalPage)
 518     delete finalPage;
 519
 520   foreach (QObject *w, widgetsToDelete)
 521     {
 522       delete w;
 523     }
 524
 525   if (lineEditValidator)
 526     delete lineEditValidator;
 527 }
 528
 529 QString
 530 ApplicationForm::buildElementPath (QString path, QString element,
 531                                    bool &notFound)
 532 {
 533   foreach (ApplicationFormWidget *w, stream->widgets ())
 534     {
 535       if (w->id () == element)
 536         {
 537           if (!w->childOf ().isEmpty ())
 538             {
 539               path = buildElementPath (path, w->childOf (), notFound);
 540               if (path.isEmpty () && w->childOf () != "pwmdRootElement")
 541                 {
 542                   qWarning ("%s: could not find parent '%s'\n",
 543                             element.toUtf8 ().data (),
 544                             w->childOf ().toUtf8 ().data ());
 545                   notFound = true;
 546                   return QString ();
 547                 }
 548
 549               if (!w->pwmdName ().isEmpty ())
 550                 {
 551                   if (!path.isEmpty ())
 552                     path.append ("\t");
 553                   path.append (w->pwmdName ());
 554                 }
 555               else if (!w->value ().isEmpty ())
 556                 {
 557                   if (!path.isEmpty ())
 558                     path.append ("\t");
 559                   path.append (w->value ());
 560                 }
 561             }
 562           else
 563             {
 564               if (!w->pwmdName ().isEmpty ())
 565                 path.append (w->pwmdName ());
 566
 567               if (!w->value ().isEmpty ())
 568                 {
 569                   if (!w->pwmdName ().isEmpty ())
 570                     path.append ("\t");
 571
 572                   path.append (w->value ());
 573                 }
 574             }
 575
 576           return path;
 577         }
 578     }
 579
 580   return path;
 581 }