src/qtui/settingspages/bufferviewsettingspage.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #include "bufferviewsettingspage.h"
  22
  23 #include <QMessageBox>
  24
  25 #include "client.h"
  26 #include "iconloader.h"
  27 #include "network.h"
  28 #include "bufferviewconfig.h"
  29 #include "bufferviewfilter.h"
  30 #include "bufferviewmanager.h"
  31 #include "buffermodel.h"
  32 #include "networkmodel.h"
  33
  34 BufferViewSettingsPage::BufferViewSettingsPage(QWidget *parent)
  35   : SettingsPage(tr("General"), tr("Buffer Views"), parent),
  36     _ignoreWidgetChanges(false),
  37     _useBufferViewHint(false),
  38     _bufferViewHint(0)
  39 {
  40   ui.setupUi(this);
  41   ui.renameBufferView->setIcon(SmallIcon("edit-rename"));
  42   ui.addBufferView->setIcon(SmallIcon("list-add"));
  43   ui.deleteBufferView->setIcon(SmallIcon("edit-delete"));
  44
  45   reset();
  46
  47   ui.bufferViewList->setSortingEnabled(true);
  48   ui.settingsGroupBox->setEnabled(false);
  49   ui.bufferViewPreview->setEnabled(false);
  50
  51   coreConnectionStateChanged(Client::isConnected());  // need a core connection!
  52   connect(Client::instance(), SIGNAL(coreConnectionStateChanged(bool)), this, SLOT(coreConnectionStateChanged(bool)));
  53   connect(ui.bufferViewList->selectionModel(), SIGNAL(selectionChanged(const QItemSelection &, const QItemSelection &)),
  54           this, SLOT(bufferViewSelectionChanged(const QItemSelection &, const QItemSelection &)));
  55
  56   connect(ui.onlyStatusBuffers, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  57   connect(ui.onlyChannelBuffers, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  58   connect(ui.onlyQueryBuffers, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  59   connect(ui.addNewBuffersAutomatically, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  60   connect(ui.sortAlphabetically, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  61   connect(ui.hideInactiveBuffers, SIGNAL(clicked(bool)), this, SLOT(widgetHasChanged()));
  62   connect(ui.networkSelector, SIGNAL(currentIndexChanged(int)), this, SLOT(widgetHasChanged()));
  63   connect(ui.minimumActivitySelector, SIGNAL(currentIndexChanged(int)), this, SLOT(widgetHasChanged()));
  64 }
  65
  66 BufferViewSettingsPage::~BufferViewSettingsPage() {
  67   reset();
  68 }
  69
  70 void BufferViewSettingsPage::reset() {
  71   ui.bufferViewList->clear();
  72
  73   QHash<BufferViewConfig *, BufferViewConfig *>::iterator changedConfigIter = _changedBufferViews.begin();
  74   QHash<BufferViewConfig *, BufferViewConfig *>::iterator changedConfigIterEnd = _changedBufferViews.end();
  75   BufferViewConfig *config;
  76   while(changedConfigIter != changedConfigIterEnd) {
  77     config = changedConfigIter.value();
  78     changedConfigIter = _changedBufferViews.erase(changedConfigIter);
  79     config->deleteLater();
  80   }
  81
  82   QList<BufferViewConfig *>::iterator newConfigIter = _newBufferViews.begin();
  83   QList<BufferViewConfig *>::iterator newConfigIterEnd = _newBufferViews.end();
  84   while(newConfigIter != newConfigIterEnd) {
  85     config = *newConfigIter;
  86     newConfigIter = _newBufferViews.erase(newConfigIter);
  87     config->deleteLater();
  88   }
  89
  90   _deleteBufferViews.clear();
  91
  92   bool _useBufferViewHint;
  93   int _bufferViewHint;
  94
  95   setChangedState(false);
  96 }
  97
  98 void BufferViewSettingsPage::load() {
  99   bool useBufferViewHint = _useBufferViewHint;
 100   int bufferViewHint = _bufferViewHint;
 101   reset();
 102
 103   if(!Client::bufferViewManager())
 104     return;
 105
 106   const QList<BufferViewConfig *> bufferViewConfigs = Client::bufferViewManager()->bufferViewConfigs();
 107   foreach(BufferViewConfig *bufferViewConfig, bufferViewConfigs) {
 108     addBufferView(bufferViewConfig);
 109   }
 110
 111   _ignoreWidgetChanges = true;
 112   // load network selector
 113   ui.networkSelector->clear();
 114   ui.networkSelector->addItem(tr("All"));
 115   ui.networkSelector->setItemData(0, qVariantFromValue<NetworkId>(NetworkId()));
 116   const Network *net;
 117   foreach(NetworkId netId, Client::networkIds()) {
 118     net = Client::network(netId);
 119     ui.networkSelector->addItem(net->networkName());
 120     ui.networkSelector->setItemData(ui.networkSelector->count() - 1, qVariantFromValue<NetworkId>(net->networkId()));
 121   }
 122   _ignoreWidgetChanges = false;
 123
 124
 125   if(!useBufferViewHint || !selectBufferViewById(bufferViewHint))
 126     ui.bufferViewList->setCurrentRow(0);
 127 }
 128
 129 void BufferViewSettingsPage::save() {
 130   setEnabled(false);
 131
 132   BufferViewConfig *currentConfig = bufferView(ui.bufferViewList->currentRow());
 133   if(currentConfig) {
 134     _useBufferViewHint = true;
 135     _bufferViewHint = currentConfig->bufferViewId();
 136   }
 137
 138   QVariantList newConfigs;
 139   QVariantList deleteConfigs;
 140   QVariantList changedConfigs;
 141
 142   foreach(int bufferId, _deleteBufferViews) {
 143     deleteConfigs << bufferId;
 144   }
 145   _deleteBufferViews.clear();
 146   if(Client::bufferViewManager()) {
 147     Client::bufferViewManager()->requestDeleteBufferViews(deleteConfigs);
 148   }
 149
 150   QHash<BufferViewConfig *, BufferViewConfig *>::iterator changedConfigIter = _changedBufferViews.begin();
 151   QHash<BufferViewConfig *, BufferViewConfig *>::iterator changedConfigIterEnd = _changedBufferViews.end();
 152   BufferViewConfig *config, *changedConfig;
 153   while(changedConfigIter != changedConfigIterEnd) {
 154     config = changedConfigIter.key();
 155     changedConfig = changedConfigIter.value();
 156     changedConfigIter = _changedBufferViews.erase(changedConfigIter);
 157     config->requestUpdate(changedConfig->toVariantMap());
 158     changedConfig->deleteLater();
 159   }
 160
 161   QList<BufferViewConfig *>::iterator newConfigIter = _newBufferViews.begin();
 162   QList<BufferViewConfig *>::iterator newConfigIterEnd = _newBufferViews.end();
 163   while(newConfigIter != newConfigIterEnd) {
 164     config = *newConfigIter;
 165     newConfigIter = _newBufferViews.erase(newConfigIter);
 166     newConfigs << config->toVariantMap();
 167     config->deleteLater();
 168   }
 169   if(Client::bufferViewManager()) {
 170     Client::bufferViewManager()->requestCreateBufferViews(newConfigs);
 171   }
 172
 173   load();
 174   setEnabled(true);
 175 }
 176
 177 void BufferViewSettingsPage::coreConnectionStateChanged(bool state) {
 178   setEnabled(state);
 179   if(state) {
 180     load();
 181     connect(Client::bufferViewManager(), SIGNAL(bufferViewConfigAdded(int)), this, SLOT(addBufferView(int)));
 182   } else {
 183     reset();
 184   }
 185 }
 186
 187 void BufferViewSettingsPage::addBufferView(BufferViewConfig *config) {
 188   QListWidgetItem *item = new QListWidgetItem(config->bufferViewName(), ui.bufferViewList);
 189   item->setData(Qt::UserRole, qVariantFromValue<QObject *>(qobject_cast<QObject *>(config)));
 190   connect(config, SIGNAL(updatedRemotely()), this, SLOT(updateBufferView()));
 191   connect(config, SIGNAL(destroyed()), this, SLOT(bufferViewDeleted()));
 192 }
 193
 194 void BufferViewSettingsPage::addBufferView(int bufferViewId) {
 195   qDebug() << "addBufferView" << bufferViewId;
 196   // we are informed about a new bufferview from Client::bufferViewManager()
 197   Q_ASSERT(Client::bufferViewManager());
 198   addBufferView(Client::bufferViewManager()->bufferViewConfig(bufferViewId));
 199   selectBufferViewById(bufferViewId);
 200 }
 201
 202 void BufferViewSettingsPage::bufferViewDeleted() {
 203   BufferViewConfig *config = static_cast<BufferViewConfig *>(sender());
 204   QObject *obj;
 205   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 206     obj = ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>();
 207     if(config == static_cast<BufferViewConfig *>(obj)) {
 208       QListWidgetItem *item = ui.bufferViewList->takeItem(i);
 209       delete item;
 210       return;
 211     }
 212   }
 213 }
 214
 215 void BufferViewSettingsPage::newBufferView(const QString &bufferViewName) {
 216   // id's of newly created bufferviews are negative (-1, -2... -n)
 217   int fakeId = -1 * (_newBufferViews.count() + 1);
 218   BufferViewConfig *config = new BufferViewConfig(fakeId);
 219   config->setBufferViewName(bufferViewName);
 220   config->setInitialized();
 221   QList<BufferId> bufferIds;
 222   if(config->addNewBuffersAutomatically()) {
 223     bufferIds = Client::networkModel()->allBufferIds();
 224     if(config->sortAlphabetically())
 225       qSort(bufferIds.begin(), bufferIds.end(), bufferIdLessThan);
 226   }
 227   config->initSetBufferList(bufferIds);
 228
 229   _newBufferViews << config;
 230   addBufferView(config);
 231   ui.bufferViewList->setCurrentRow(listPos(config));
 232 }
 233
 234 int BufferViewSettingsPage::listPos(BufferViewConfig *config) {
 235   QObject *obj;
 236   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 237     obj = ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>();
 238     if(config == qobject_cast<BufferViewConfig *>(obj))
 239       return i;
 240   }
 241   return -1;
 242 }
 243
 244 BufferViewConfig *BufferViewSettingsPage::bufferView(int listPos) {
 245   if(listPos < ui.bufferViewList->count() && listPos >= 0) {
 246     QObject *obj = ui.bufferViewList->item(listPos)->data(Qt::UserRole).value<QObject *>();
 247     return qobject_cast<BufferViewConfig *>(obj);
 248   } else {
 249     return 0;
 250   }
 251 }
 252
 253 bool BufferViewSettingsPage::selectBufferViewById(int bufferViewId) {
 254   BufferViewConfig *config;
 255   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 256     config = qobject_cast<BufferViewConfig *>(ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>());
 257     if(config && config->bufferViewId() == bufferViewId) {
 258       ui.bufferViewList->setCurrentRow(i);
 259       return true;
 260     }
 261   }
 262   return false;
 263 }
 264
 265 void BufferViewSettingsPage::updateBufferView() {
 266   BufferViewConfig *config = qobject_cast<BufferViewConfig *>(sender());
 267   if(!config)
 268     return;
 269
 270   int itemPos = listPos(config);
 271   if(itemPos == -1) {
 272     qWarning() << "BufferViewSettingsPage::updateBufferView(): view is unknown:" << config->bufferViewId();
 273     return;
 274   }
 275   ui.bufferViewList->item(itemPos)->setText(config->bufferViewName());
 276   if(itemPos == ui.bufferViewList->currentRow())
 277     loadConfig(config);
 278 }
 279
 280 void BufferViewSettingsPage::on_addBufferView_clicked() {
 281   if(!Client::bufferViewManager())
 282     return;
 283
 284   QStringList existing;
 285   foreach(BufferViewConfig *bufferConfig, Client::bufferViewManager()->bufferViewConfigs()) {
 286     existing << bufferConfig->bufferViewName();
 287   }
 288
 289   BufferViewEditDlg dlg(QString(), existing, this);
 290   if(dlg.exec() == QDialog::Accepted) {
 291     newBufferView(dlg.bufferViewName());
 292     changed();
 293   }
 294 }
 295
 296 void BufferViewSettingsPage::on_renameBufferView_clicked() {
 297   if(ui.bufferViewList->selectedItems().isEmpty())
 298     return;
 299
 300   if(!Client::bufferViewManager())
 301     return;
 302
 303   BufferViewConfig *config = bufferView(ui.bufferViewList->currentRow());
 304   if(!config)
 305     return;
 306
 307   QStringList existing;
 308   foreach(BufferViewConfig *bufferConfig, Client::bufferViewManager()->bufferViewConfigs()) {
 309     existing << bufferConfig->bufferViewName();
 310   }
 311
 312   BufferViewEditDlg dlg(config->bufferViewName(), existing, this);
 313   if(dlg.exec() == QDialog::Accepted) {
 314     BufferViewConfig *changedConfig = cloneConfig(config);
 315     changedConfig->setBufferViewName(dlg.bufferViewName());
 316     ui.bufferViewList->item(listPos(config))->setText(dlg.bufferViewName());
 317     changed();
 318   }
 319 }
 320
 321 void BufferViewSettingsPage::on_deleteBufferView_clicked() {
 322   if(ui.bufferViewList->selectedItems().isEmpty())
 323     return;
 324
 325   QListWidgetItem *currentItem = ui.bufferViewList->item(ui.bufferViewList->currentRow());
 326   QString viewName = currentItem->text();
 327   int viewId = bufferView(ui.bufferViewList->currentRow())->bufferViewId();
 328   int ret = QMessageBox::question(this, tr("Delete Buffer View?"),
 329                                     tr("Do you really want to delete the buffer view \"%1\"?").arg(viewName),
 330                                     QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
 331
 332   if(ret == QMessageBox::Yes) {
 333     ui.bufferViewList->removeItemWidget(currentItem);
 334     delete currentItem;
 335     if(viewId >= 0)
 336       _deleteBufferViews << viewId;
 337     changed();
 338   }
 339 }
 340
 341 void BufferViewSettingsPage::bufferViewSelectionChanged(const QItemSelection &current, const QItemSelection &previous) {
 342   Q_UNUSED(previous)
 343
 344   if(!current.isEmpty()) {
 345     ui.settingsGroupBox->setEnabled(true);
 346     ui.bufferViewPreview->setEnabled(true);
 347
 348     loadConfig(configForDisplay(bufferView(ui.bufferViewList->currentRow())));
 349   } else {
 350     ui.settingsGroupBox->setEnabled(false);
 351     ui.bufferViewPreview->setEnabled(false);
 352   }
 353 }
 354
 355 void BufferViewSettingsPage::loadConfig(BufferViewConfig *config) {
 356   if(!config)
 357     return;
 358
 359   _ignoreWidgetChanges = true;
 360   ui.onlyStatusBuffers->setChecked(BufferInfo::StatusBuffer & config->allowedBufferTypes());
 361   ui.onlyChannelBuffers->setChecked(BufferInfo::ChannelBuffer & config->allowedBufferTypes());
 362   ui.onlyQueryBuffers->setChecked(BufferInfo::QueryBuffer & config->allowedBufferTypes());
 363   ui.addNewBuffersAutomatically->setChecked(config->addNewBuffersAutomatically());
 364   ui.sortAlphabetically->setChecked(config->sortAlphabetically());
 365   ui.hideInactiveBuffers->setChecked(config->hideInactiveBuffers());
 366
 367   int networkIndex = 0;
 368   for(int i = 0; i < ui.networkSelector->count(); i++) {
 369     if(ui.networkSelector->itemData(i).value<NetworkId>() == config->networkId()) {
 370       networkIndex = i;
 371       break;
 372     }
 373   }
 374   ui.networkSelector->setCurrentIndex(networkIndex);
 375
 376   int activityIndex = 0;
 377   int minimumActivity = config->minimumActivity();
 378   while(minimumActivity) {
 379     activityIndex++;
 380     minimumActivity = minimumActivity >> 1;
 381   }
 382   ui.minimumActivitySelector->setCurrentIndex(activityIndex);
 383
 384   ui.bufferViewPreview->setFilteredModel(Client::bufferModel(), config);
 385
 386   _ignoreWidgetChanges = false;
 387 }
 388
 389 void BufferViewSettingsPage::saveConfig(BufferViewConfig *config) {
 390   if(!config)
 391     return;
 392
 393   int allowedBufferTypes = 0;
 394   if(ui.onlyStatusBuffers->isChecked())
 395     allowedBufferTypes |= BufferInfo::StatusBuffer;
 396   if(ui.onlyChannelBuffers->isChecked())
 397     allowedBufferTypes |= BufferInfo::ChannelBuffer;
 398   if(ui.onlyQueryBuffers->isChecked())
 399     allowedBufferTypes |= BufferInfo::QueryBuffer;
 400   config->setAllowedBufferTypes(allowedBufferTypes);
 401
 402   config->setAddNewBuffersAutomatically(ui.addNewBuffersAutomatically->isChecked());
 403   config->setSortAlphabetically(ui.sortAlphabetically->isChecked());
 404   config->setHideInactiveBuffers(ui.hideInactiveBuffers->isChecked());
 405   config->setNetworkId(ui.networkSelector->itemData(ui.networkSelector->currentIndex()).value<NetworkId>());
 406
 407   int minimumActivity = 0;
 408   if(ui.minimumActivitySelector->currentIndex() > 0)
 409     minimumActivity = 1 << (ui.minimumActivitySelector->currentIndex() - 1);
 410   config->setMinimumActivity(minimumActivity);
 411
 412   if(_newBufferViews.contains(config)) {
 413     QList<BufferId> bufferIds;
 414     if(config->addNewBuffersAutomatically()) {
 415       bufferIds = Client::networkModel()->allBufferIds();
 416       if(config->sortAlphabetically())
 417         qSort(bufferIds.begin(), bufferIds.end(), bufferIdLessThan);
 418     }
 419     config->initSetBufferList(bufferIds);
 420   }
 421 }
 422
 423 void BufferViewSettingsPage::widgetHasChanged() {
 424   if(_ignoreWidgetChanges)
 425     return;
 426   setChangedState(testHasChanged());
 427 }
 428
 429 bool BufferViewSettingsPage::testHasChanged() {
 430   saveConfig(cloneConfig(bufferView(ui.bufferViewList->currentRow())));
 431
 432   if(!_newBufferViews.isEmpty())
 433     return true;
 434
 435   bool changed = false;
 436   QHash<BufferViewConfig *, BufferViewConfig *>::iterator iter = _changedBufferViews.begin();
 437   QHash<BufferViewConfig *, BufferViewConfig *>::iterator iterEnd = _changedBufferViews.end();
 438   while(iter != iterEnd) {
 439     if(&(iter.key()) == &(iter.value())) {
 440       iter.value()->deleteLater();
 441       _changedBufferViews.erase(iter);
 442     } else {
 443       changed = true;
 444       iter++;
 445     }
 446   }
 447   return changed;
 448 }
 449
 450 BufferViewConfig *BufferViewSettingsPage::cloneConfig(BufferViewConfig *config) {
 451   if(!config || config->bufferViewId() < 0)
 452     return config;
 453
 454   if(_changedBufferViews.contains(config))
 455     return _changedBufferViews[config];
 456
 457   BufferViewConfig *changedConfig = new BufferViewConfig(-1, this);
 458   changedConfig->fromVariantMap(config->toVariantMap());
 459   changedConfig->setInitialized();
 460   _changedBufferViews[config] = changedConfig;
 461   connect(config, SIGNAL(bufferAdded(const BufferId &, int)), changedConfig, SLOT(addBuffer(const BufferId &, int)));
 462   connect(config, SIGNAL(bufferMoved(const BufferId &, int)), changedConfig, SLOT(moveBuffer(const BufferId &, int)));
 463   connect(config, SIGNAL(bufferRemoved(const BufferId &)), changedConfig, SLOT(removeBuffer(const BufferId &)));
 464   connect(config, SIGNAL(addBufferRequested(const BufferId &, int)), changedConfig, SLOT(addBuffer(const BufferId &, int)));
 465   connect(config, SIGNAL(moveBufferRequested(const BufferId &, int)), changedConfig, SLOT(moveBuffer(const BufferId &, int)));
 466   connect(config, SIGNAL(removeBufferRequested(const BufferId &)), changedConfig, SLOT(removeBuffer(const BufferId &)));
 467
 468   // if this is the currently displayed view we have to change the config of the preview filter
 469   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(ui.bufferViewPreview->model());
 470   if(filter && filter->config() == config)
 471     filter->setConfig(changedConfig);
 472   ui.bufferViewPreview->setConfig(changedConfig);
 473
 474   return changedConfig;
 475 }
 476
 477 BufferViewConfig *BufferViewSettingsPage::configForDisplay(BufferViewConfig *config) {
 478   if(_changedBufferViews.contains(config))
 479     return _changedBufferViews[config];
 480   else
 481     return config;
 482 }
 483
 484
 485 /**************************************************************************
 486  * BufferViewEditDlg
 487  *************************************************************************/
 488 BufferViewEditDlg::BufferViewEditDlg(const QString &old, const QStringList &exist, QWidget *parent) : QDialog(parent), existing(exist) {
 489   ui.setupUi(this);
 490
 491   if(old.isEmpty()) {
 492     // new buffer
 493     setWindowTitle(tr("Add Buffer View"));
 494     on_bufferViewEdit_textChanged(""); // disable ok button
 495   } else {
 496     ui.bufferViewEdit->setText(old);
 497   }
 498 }
 499
 500
 501 void BufferViewEditDlg::on_bufferViewEdit_textChanged(const QString &text) {
 502   ui.buttonBox->button(QDialogButtonBox::Ok)->setDisabled(text.isEmpty() || existing.contains(text));
 503 }
 504