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   // we are informed about a new bufferview from Client::bufferViewManager()
 196   Q_ASSERT(Client::bufferViewManager());
 197   addBufferView(Client::bufferViewManager()->bufferViewConfig(bufferViewId));
 198   selectBufferViewById(bufferViewId);
 199 }
 200
 201 void BufferViewSettingsPage::bufferViewDeleted() {
 202   BufferViewConfig *config = static_cast<BufferViewConfig *>(sender());
 203   QObject *obj;
 204   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 205     obj = ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>();
 206     if(config == static_cast<BufferViewConfig *>(obj)) {
 207       QListWidgetItem *item = ui.bufferViewList->takeItem(i);
 208       delete item;
 209       return;
 210     }
 211   }
 212 }
 213
 214 void BufferViewSettingsPage::newBufferView(const QString &bufferViewName) {
 215   // id's of newly created bufferviews are negative (-1, -2... -n)
 216   int fakeId = -1 * (_newBufferViews.count() + 1);
 217   BufferViewConfig *config = new BufferViewConfig(fakeId);
 218   config->setBufferViewName(bufferViewName);
 219   config->setInitialized();
 220   QList<BufferId> bufferIds;
 221   if(config->addNewBuffersAutomatically()) {
 222     bufferIds = Client::networkModel()->allBufferIds();
 223     if(config->sortAlphabetically())
 224       qSort(bufferIds.begin(), bufferIds.end(), bufferIdLessThan);
 225   }
 226   config->initSetBufferList(bufferIds);
 227
 228   _newBufferViews << config;
 229   addBufferView(config);
 230   ui.bufferViewList->setCurrentRow(listPos(config));
 231 }
 232
 233 int BufferViewSettingsPage::listPos(BufferViewConfig *config) {
 234   QObject *obj;
 235   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 236     obj = ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>();
 237     if(config == qobject_cast<BufferViewConfig *>(obj))
 238       return i;
 239   }
 240   return -1;
 241 }
 242
 243 BufferViewConfig *BufferViewSettingsPage::bufferView(int listPos) {
 244   if(listPos < ui.bufferViewList->count() && listPos >= 0) {
 245     QObject *obj = ui.bufferViewList->item(listPos)->data(Qt::UserRole).value<QObject *>();
 246     return qobject_cast<BufferViewConfig *>(obj);
 247   } else {
 248     return 0;
 249   }
 250 }
 251
 252 bool BufferViewSettingsPage::selectBufferViewById(int bufferViewId) {
 253   BufferViewConfig *config;
 254   for(int i = 0; i < ui.bufferViewList->count(); i++) {
 255     config = qobject_cast<BufferViewConfig *>(ui.bufferViewList->item(i)->data(Qt::UserRole).value<QObject *>());
 256     if(config && config->bufferViewId() == bufferViewId) {
 257       ui.bufferViewList->setCurrentRow(i);
 258       return true;
 259     }
 260   }
 261   return false;
 262 }
 263
 264 void BufferViewSettingsPage::updateBufferView() {
 265   BufferViewConfig *config = qobject_cast<BufferViewConfig *>(sender());
 266   if(!config)
 267     return;
 268
 269   int itemPos = listPos(config);
 270   if(itemPos == -1) {
 271     qWarning() << "BufferViewSettingsPage::updateBufferView(): view is unknown:" << config->bufferViewId();
 272     return;
 273   }
 274   ui.bufferViewList->item(itemPos)->setText(config->bufferViewName());
 275   if(itemPos == ui.bufferViewList->currentRow())
 276     loadConfig(config);
 277 }
 278
 279 void BufferViewSettingsPage::on_addBufferView_clicked() {
 280   if(!Client::bufferViewManager())
 281     return;
 282
 283   QStringList existing;
 284   foreach(BufferViewConfig *bufferConfig, Client::bufferViewManager()->bufferViewConfigs()) {
 285     existing << bufferConfig->bufferViewName();
 286   }
 287
 288   BufferViewEditDlg dlg(QString(), existing, this);
 289   if(dlg.exec() == QDialog::Accepted) {
 290     newBufferView(dlg.bufferViewName());
 291     changed();
 292   }
 293 }
 294
 295 void BufferViewSettingsPage::on_renameBufferView_clicked() {
 296   if(ui.bufferViewList->selectedItems().isEmpty())
 297     return;
 298
 299   if(!Client::bufferViewManager())
 300     return;
 301
 302   BufferViewConfig *config = bufferView(ui.bufferViewList->currentRow());
 303   if(!config)
 304     return;
 305
 306   QStringList existing;
 307   foreach(BufferViewConfig *bufferConfig, Client::bufferViewManager()->bufferViewConfigs()) {
 308     existing << bufferConfig->bufferViewName();
 309   }
 310
 311   BufferViewEditDlg dlg(config->bufferViewName(), existing, this);
 312   if(dlg.exec() == QDialog::Accepted) {
 313     BufferViewConfig *changedConfig = cloneConfig(config);
 314     changedConfig->setBufferViewName(dlg.bufferViewName());
 315     ui.bufferViewList->item(listPos(config))->setText(dlg.bufferViewName());
 316     changed();
 317   }
 318 }
 319
 320 void BufferViewSettingsPage::on_deleteBufferView_clicked() {
 321   if(ui.bufferViewList->selectedItems().isEmpty())
 322     return;
 323
 324   QListWidgetItem *currentItem = ui.bufferViewList->item(ui.bufferViewList->currentRow());
 325   QString viewName = currentItem->text();
 326   int viewId = bufferView(ui.bufferViewList->currentRow())->bufferViewId();
 327   int ret = QMessageBox::question(this, tr("Delete Buffer View?"),
 328                                     tr("Do you really want to delete the buffer view \"%1\"?").arg(viewName),
 329                                     QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
 330
 331   if(ret == QMessageBox::Yes) {
 332     ui.bufferViewList->removeItemWidget(currentItem);
 333     delete currentItem;
 334     if(viewId >= 0)
 335       _deleteBufferViews << viewId;
 336     changed();
 337   }
 338 }
 339
 340 void BufferViewSettingsPage::bufferViewSelectionChanged(const QItemSelection &current, const QItemSelection &previous) {
 341   Q_UNUSED(previous)
 342
 343   if(!current.isEmpty()) {
 344     ui.settingsGroupBox->setEnabled(true);
 345     ui.bufferViewPreview->setEnabled(true);
 346
 347     loadConfig(configForDisplay(bufferView(ui.bufferViewList->currentRow())));
 348   } else {
 349     ui.settingsGroupBox->setEnabled(false);
 350     ui.bufferViewPreview->setEnabled(false);
 351   }
 352 }
 353
 354 void BufferViewSettingsPage::loadConfig(BufferViewConfig *config) {
 355   if(!config)
 356     return;
 357
 358   _ignoreWidgetChanges = true;
 359   ui.onlyStatusBuffers->setChecked(BufferInfo::StatusBuffer & config->allowedBufferTypes());
 360   ui.onlyChannelBuffers->setChecked(BufferInfo::ChannelBuffer & config->allowedBufferTypes());
 361   ui.onlyQueryBuffers->setChecked(BufferInfo::QueryBuffer & config->allowedBufferTypes());
 362   ui.addNewBuffersAutomatically->setChecked(config->addNewBuffersAutomatically());
 363   ui.sortAlphabetically->setChecked(config->sortAlphabetically());
 364   ui.hideInactiveBuffers->setChecked(config->hideInactiveBuffers());
 365
 366   int networkIndex = 0;
 367   for(int i = 0; i < ui.networkSelector->count(); i++) {
 368     if(ui.networkSelector->itemData(i).value<NetworkId>() == config->networkId()) {
 369       networkIndex = i;
 370       break;
 371     }
 372   }
 373   ui.networkSelector->setCurrentIndex(networkIndex);
 374
 375   int activityIndex = 0;
 376   int minimumActivity = config->minimumActivity();
 377   while(minimumActivity) {
 378     activityIndex++;
 379     minimumActivity = minimumActivity >> 1;
 380   }
 381   ui.minimumActivitySelector->setCurrentIndex(activityIndex);
 382
 383   ui.bufferViewPreview->setFilteredModel(Client::bufferModel(), config);
 384
 385   _ignoreWidgetChanges = false;
 386 }
 387
 388 void BufferViewSettingsPage::saveConfig(BufferViewConfig *config) {
 389   if(!config)
 390     return;
 391
 392   int allowedBufferTypes = 0;
 393   if(ui.onlyStatusBuffers->isChecked())
 394     allowedBufferTypes |= BufferInfo::StatusBuffer;
 395   if(ui.onlyChannelBuffers->isChecked())
 396     allowedBufferTypes |= BufferInfo::ChannelBuffer;
 397   if(ui.onlyQueryBuffers->isChecked())
 398     allowedBufferTypes |= BufferInfo::QueryBuffer;
 399   config->setAllowedBufferTypes(allowedBufferTypes);
 400
 401   config->setAddNewBuffersAutomatically(ui.addNewBuffersAutomatically->isChecked());
 402   config->setSortAlphabetically(ui.sortAlphabetically->isChecked());
 403   config->setHideInactiveBuffers(ui.hideInactiveBuffers->isChecked());
 404   config->setNetworkId(ui.networkSelector->itemData(ui.networkSelector->currentIndex()).value<NetworkId>());
 405
 406   int minimumActivity = 0;
 407   if(ui.minimumActivitySelector->currentIndex() > 0)
 408     minimumActivity = 1 << (ui.minimumActivitySelector->currentIndex() - 1);
 409   config->setMinimumActivity(minimumActivity);
 410
 411   if(_newBufferViews.contains(config)) {
 412     QList<BufferId> bufferIds;
 413     if(config->addNewBuffersAutomatically()) {
 414       bufferIds = Client::networkModel()->allBufferIds();
 415       if(config->sortAlphabetically())
 416         qSort(bufferIds.begin(), bufferIds.end(), bufferIdLessThan);
 417     }
 418     config->initSetBufferList(bufferIds);
 419   }
 420 }
 421
 422 void BufferViewSettingsPage::widgetHasChanged() {
 423   if(_ignoreWidgetChanges)
 424     return;
 425   setChangedState(testHasChanged());
 426 }
 427
 428 bool BufferViewSettingsPage::testHasChanged() {
 429   saveConfig(cloneConfig(bufferView(ui.bufferViewList->currentRow())));
 430
 431   if(!_newBufferViews.isEmpty())
 432     return true;
 433
 434   bool changed = false;
 435   QHash<BufferViewConfig *, BufferViewConfig *>::iterator iter = _changedBufferViews.begin();
 436   QHash<BufferViewConfig *, BufferViewConfig *>::iterator iterEnd = _changedBufferViews.end();
 437   while(iter != iterEnd) {
 438     if(&(iter.key()) == &(iter.value())) {
 439       iter.value()->deleteLater();
 440       _changedBufferViews.erase(iter);
 441     } else {
 442       changed = true;
 443       iter++;
 444     }
 445   }
 446   return changed;
 447 }
 448
 449 BufferViewConfig *BufferViewSettingsPage::cloneConfig(BufferViewConfig *config) {
 450   if(!config || config->bufferViewId() < 0)
 451     return config;
 452
 453   if(_changedBufferViews.contains(config))
 454     return _changedBufferViews[config];
 455
 456   BufferViewConfig *changedConfig = new BufferViewConfig(-1, this);
 457   changedConfig->fromVariantMap(config->toVariantMap());
 458   changedConfig->setInitialized();
 459   _changedBufferViews[config] = changedConfig;
 460   connect(config, SIGNAL(bufferAdded(const BufferId &, int)), changedConfig, SLOT(addBuffer(const BufferId &, int)));
 461   connect(config, SIGNAL(bufferMoved(const BufferId &, int)), changedConfig, SLOT(moveBuffer(const BufferId &, int)));
 462   connect(config, SIGNAL(bufferRemoved(const BufferId &)), changedConfig, SLOT(removeBuffer(const BufferId &)));
 463   connect(config, SIGNAL(addBufferRequested(const BufferId &, int)), changedConfig, SLOT(addBuffer(const BufferId &, int)));
 464   connect(config, SIGNAL(moveBufferRequested(const BufferId &, int)), changedConfig, SLOT(moveBuffer(const BufferId &, int)));
 465   connect(config, SIGNAL(removeBufferRequested(const BufferId &)), changedConfig, SLOT(removeBuffer(const BufferId &)));
 466
 467   // if this is the currently displayed view we have to change the config of the preview filter
 468   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(ui.bufferViewPreview->model());
 469   if(filter && filter->config() == config)
 470     filter->setConfig(changedConfig);
 471   ui.bufferViewPreview->setConfig(changedConfig);
 472
 473   return changedConfig;
 474 }
 475
 476 BufferViewConfig *BufferViewSettingsPage::configForDisplay(BufferViewConfig *config) {
 477   if(_changedBufferViews.contains(config))
 478     return _changedBufferViews[config];
 479   else
 480     return config;
 481 }
 482
 483
 484 /**************************************************************************
 485  * BufferViewEditDlg
 486  *************************************************************************/
 487 BufferViewEditDlg::BufferViewEditDlg(const QString &old, const QStringList &exist, QWidget *parent) : QDialog(parent), existing(exist) {
 488   ui.setupUi(this);
 489
 490   if(old.isEmpty()) {
 491     // new buffer
 492     setWindowTitle(tr("Add Buffer View"));
 493     on_bufferViewEdit_textChanged(""); // disable ok button
 494   } else {
 495     ui.bufferViewEdit->setText(old);
 496   }
 497 }
 498
 499
 500 void BufferViewEditDlg::on_bufferViewEdit_textChanged(const QString &text) {
 501   ui.buttonBox->button(QDialogButtonBox::Ok)->setDisabled(text.isEmpty() || existing.contains(text));
 502 }
 503