runtime/kurifilter-plugins/ikws/ikwsopts.cpp

   1 /*
   2  * Copyright (c) 2000 Yves Arrouye <yves@realnames.com>
   3  * Copyright (c) 2001, 2002 Dawit Alemayehu <adawit@kde.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) any later version.
   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 Free Software
  17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #include "ikwsopts.h"
  21
  22 #include <QFile>
  23
  24 #include <QtDBus/QtDBus>
  25
  26 #include <kbuildsycocaprogressdialog.h>
  27 #include <kstandarddirs.h>
  28 #include <kservicetypetrader.h>
  29
  30 #include "kuriikwsfiltereng.h"
  31 #include "searchprovider.h"
  32 #include "searchproviderdlg.h"
  33
  34 class SearchProviderItem : public QTreeWidgetItem
  35 {
  36 public:
  37     SearchProviderItem(QTreeWidget *parent, SearchProvider *provider)
  38     :QTreeWidgetItem(parent, QStringList() << provider->name()), m_provider(provider)
  39     {
  40       setFlags(Qt::ItemIsSelectable | Qt::ItemIsUserCheckable | Qt::ItemIsEnabled);
  41       update();
  42     }
  43
  44     virtual ~SearchProviderItem()
  45     {
  46       delete m_provider;
  47     }
  48
  49     void update()
  50     {
  51       setText(0, m_provider->name());
  52       setText(1, m_provider->keys().join(","));
  53     }
  54
  55     SearchProvider *provider() const { return m_provider; }
  56
  57 private:
  58     SearchProvider *m_provider;
  59 };
  60
  61 FilterOptions::FilterOptions(const KComponentData &componentData, QWidget *parent)
  62               :KCModule(componentData, parent)
  63 {
  64     QVBoxLayout *mainLayout = new QVBoxLayout( this );
  65
  66     m_dlg = new FilterOptionsUI (this);
  67     mainLayout->addWidget(m_dlg);
  68
  69     m_dlg->lvSearchProviders->setColumnWidth(0, 200);
  70
  71     // Connect all the signals/slots...
  72     connect(m_dlg->cbEnableShortcuts, SIGNAL(toggled(bool)), this,
  73             SLOT(setWebShortcutState()));
  74     connect(m_dlg->cbEnableShortcuts, SIGNAL(toggled(bool)), this,
  75             SLOT(configChanged()));
  76
  77     connect(m_dlg->lvSearchProviders, SIGNAL(currentItemChanged(QTreeWidgetItem *, QTreeWidgetItem *)),
  78            this, SLOT(updateSearchProvider()));
  79     connect(m_dlg->lvSearchProviders, SIGNAL(itemDoubleClicked(QTreeWidgetItem *, int)),
  80            this, SLOT(changeSearchProvider()));
  81     connect(m_dlg->lvSearchProviders, SIGNAL(itemChanged(QTreeWidgetItem *, int)),
  82            this, SLOT(checkFavoritesChanged()));
  83
  84     connect(m_dlg->cmbDefaultEngine, SIGNAL(currentIndexChanged(int)), this,
  85             SLOT(configChanged()));
  86     connect(m_dlg->cmbDelimiter, SIGNAL(currentIndexChanged(int)), this,
  87             SLOT(configChanged()));
  88
  89     connect(m_dlg->pbNew, SIGNAL(clicked()), this, SLOT(addSearchProvider()));
  90     connect(m_dlg->pbChange, SIGNAL(clicked()), this, SLOT(changeSearchProvider()));
  91     connect(m_dlg->pbDelete, SIGNAL(clicked()), this, SLOT(deleteSearchProvider()));
  92 }
  93
  94 QString FilterOptions::quickHelp() const
  95 {
  96     return i18n("<p>In this module you can configure the web shortcuts feature. "
  97                 "Web shortcuts allow you to quickly search or lookup words on "
  98                 "the Internet. For example, to search for information about the "
  99                 "KDE project using the Google engine, you simply type <b>gg:KDE</b> "
 100                 "or <b>google:KDE</b>.</p>"
 101                 "<p>If you select a default search engine, normal words or phrases "
 102                 "will be looked up at the specified search engine by simply typing "
 103                 "them into applications, such as Konqueror, that have built-in support "
 104                 "for such a feature.</p>");
 105 }
 106
 107 void FilterOptions::load()
 108 {
 109     // Clear state first.
 110     m_dlg->lvSearchProviders->clear();
 111
 112     KConfig config( KURISearchFilterEngine::self()->name() + "rc", KConfig::NoGlobals );
 113     KConfigGroup group = config.group("General");
 114
 115     QString defaultSearchEngine = group.readEntry("DefaultSearchEngine");
 116
 117     m_favoriteEngines.clear();
 118     m_favoriteEngines << "google" << "google_groups" << "google_news" << "webster" << "dmoz" << "wikipedia";
 119     m_favoriteEngines = group.readEntry("FavoriteSearchEngines", m_favoriteEngines );
 120
 121     const KService::List services = KServiceTypeTrader::self()->query("SearchProvider");
 122
 123     m_dlg->lvSearchProviders->blockSignals(true); // do not emit itemChanged signals
 124     for (KService::List::ConstIterator it = services.begin();
 125          it != services.end(); ++it)
 126     {
 127       displaySearchProvider(new SearchProvider(*it),
 128                             ((*it)->desktopEntryName() == defaultSearchEngine));
 129     }
 130     m_dlg->lvSearchProviders->blockSignals(false);
 131
 132     bool webShortcutsEnabled = group.readEntry("EnableWebShortcuts", true);
 133     m_dlg->cbEnableShortcuts->setChecked( webShortcutsEnabled );
 134
 135     QString delimiter = group.readEntry ("KeywordDelimiter", ":");
 136     setDelimiter( delimiter[0].toLatin1() );
 137
 138     // Update the GUI to reflect the config options read above...
 139     setWebShortcutState();
 140
 141     if (m_dlg->lvSearchProviders->topLevelItemCount() > 0)
 142       m_dlg->lvSearchProviders->setCurrentItem(m_dlg->lvSearchProviders->topLevelItem(0));
 143 }
 144
 145 char FilterOptions::delimiter ()
 146 {
 147   switch (m_dlg->cmbDelimiter->currentIndex())
 148   {
 149     case 1:
 150       return ' ';
 151     case 0:
 152     default:
 153       return ':';
 154   };
 155 }
 156
 157 void FilterOptions::setDelimiter (char sep)
 158 {
 159   switch (sep)
 160   {
 161     case ' ':
 162       m_dlg->cmbDelimiter->setCurrentIndex (1);
 163       break;
 164     case ':':
 165     default:
 166       m_dlg->cmbDelimiter->setCurrentIndex (0);
 167   };
 168 }
 169
 170 void FilterOptions::save()
 171 {
 172   KConfig config( KURISearchFilterEngine::self()->name() + "rc", KConfig::NoGlobals );
 173
 174   KConfigGroup group = config.group("General");
 175   group.writeEntry("EnableWebShortcuts", m_dlg->cbEnableShortcuts->isChecked());
 176   group.writeEntry("KeywordDelimiter", QString( delimiter() ) );
 177
 178   QString engine;
 179
 180   if (m_dlg->cmbDefaultEngine->currentIndex() != 0)
 181     engine = m_dlg->cmbDefaultEngine->currentText();
 182
 183   group.writeEntry("DefaultSearchEngine", m_defaultEngineMap[engine]);
 184
 185   // kDebug () << "Engine: " << m_defaultEngineMap[engine];
 186
 187   int changedProviderCount = 0;
 188   QString path = KGlobal::mainComponent().dirs()->saveLocation("services", "searchproviders/");
 189
 190   m_favoriteEngines.clear();
 191
 192   QTreeWidgetItemIterator it(m_dlg->lvSearchProviders);
 193   while (*it) {
 194     SearchProviderItem *item = dynamic_cast<SearchProviderItem *>(*it);
 195
 196     Q_ASSERT(item);
 197
 198     SearchProvider *provider = item->provider();
 199
 200     QString name = provider->desktopEntryName();
 201
 202     if (item->checkState(0) == Qt::Checked)
 203       m_favoriteEngines << name;
 204
 205     if (provider->isDirty())
 206     {
 207       changedProviderCount++;
 208
 209       if (name.isEmpty())
 210       {
 211         // New provider
 212         // Take the longest search shortcut as filename,
 213         // if such a file already exists, append a number and increase it
 214         // until the name is unique
 215         for (QStringList::ConstIterator it = provider->keys().begin(); it != provider->keys().end(); ++it)
 216         {
 217             if ((*it).length() > name.length())
 218                 name = (*it).toLower();
 219         }
 220         for (int suffix = 0; ; ++suffix)
 221         {
 222             QString located, check = name;
 223             if (suffix)
 224                 check += QString().setNum(suffix);
 225             if ((located = KStandardDirs::locate("services", "searchproviders/" + check + ".desktop")).isEmpty())
 226             {
 227                 name = check;
 228                 break;
 229             }
 230             else if (located.left(path.length()) == path)
 231             {
 232                 // If it's a deleted (hidden) entry, overwrite it
 233                 if (KService(located).isDeleted())
 234                     break;
 235             }
 236         }
 237       }
 238
 239       KConfig _service( path + name + ".desktop", KConfig::SimpleConfig );
 240       KConfigGroup service(&_service, "Desktop Entry");
 241       service.writeEntry("Type", "Service");
 242       service.writeEntry("ServiceTypes", "SearchProvider");
 243       service.writeEntry("Name", provider->name());
 244       service.writeEntry("Query", provider->query());
 245       service.writeEntry("Keys", provider->keys());
 246       service.writeEntry("Charset", provider->charset());
 247
 248       // we might be overwriting a hidden entry
 249       service.writeEntry("Hidden", false);
 250     }
 251     ++it;
 252   }
 253
 254   for (QStringList::ConstIterator it = m_deletedProviders.constBegin();
 255       it != m_deletedProviders.constEnd(); ++it)
 256   {
 257       QStringList matches = KGlobal::mainComponent().dirs()->findAllResources("services", "searchproviders/" + *it + ".desktop");
 258
 259       // Shouldn't happen
 260       if (!matches.count())
 261           continue;
 262
 263       if (matches.count() == 1 && matches[0].left(path.length()) == path)
 264       {
 265           // If only the local copy existed, unlink it
 266           // TODO: error handling
 267           QFile::remove(matches[0]);
 268           continue;
 269       }
 270       KConfig _service( path + *it + ".desktop", KConfig::SimpleConfig );
 271       KConfigGroup service(&_service, "Desktop Entry");
 272       service.writeEntry("Type", "Service");
 273       service.writeEntry("ServiceTypes", "SearchProvider");
 274       service.writeEntry("Hidden", true);
 275   }
 276
 277   group.writeEntry("FavoriteSearchEngines", m_favoriteEngines);
 278   config.sync();
 279
 280   emit changed(false);
 281
 282   // Update filters in running applications...
 283   QDBusMessage msg = QDBusMessage::createSignal("/", "org.kde.KUriFilterPlugin", "configure");
 284   QDBusConnection::sessionBus().send(msg);
 285
 286   // If the providers changed, tell sycoca to rebuild its database...
 287   if (changedProviderCount)
 288       KBuildSycocaProgressDialog::rebuildKSycoca(this);
 289 }
 290
 291 void FilterOptions::defaults()
 292 {
 293   setDelimiter (':');
 294   m_dlg->cmbDefaultEngine->setCurrentIndex (0);
 295   m_dlg->cbEnableShortcuts->setChecked( true );
 296 }
 297
 298 void FilterOptions::configChanged()
 299 {
 300   // kDebug () << "FilterOptions::configChanged: TRUE";
 301   emit changed(true);
 302 }
 303
 304 void FilterOptions::checkFavoritesChanged()
 305 {
 306   QStringList currentFavoriteEngines;
 307   QTreeWidgetItemIterator it(m_dlg->lvSearchProviders);
 308   while (*it) {
 309     SearchProviderItem *item = dynamic_cast<SearchProviderItem *>(*it);
 310
 311     Q_ASSERT(item);
 312
 313     if (item->checkState(0) == Qt::Checked)
 314       currentFavoriteEngines << item->provider()->desktopEntryName();
 315
 316     ++it;
 317   }
 318
 319   currentFavoriteEngines.sort(); // make sure that both lists do have the same sorting
 320   m_favoriteEngines.sort();
 321
 322   if (!(currentFavoriteEngines==m_favoriteEngines)) {
 323     m_favoriteEngines=currentFavoriteEngines;
 324     configChanged();
 325   }
 326 }
 327
 328 void FilterOptions::setWebShortcutState()
 329 {
 330   bool use_keywords = m_dlg->cbEnableShortcuts->isChecked();
 331   m_dlg->lvSearchProviders->setEnabled(use_keywords);
 332   bool itemActive = m_dlg->lvSearchProviders->currentItem() != 0;
 333   m_dlg->pbNew->setEnabled(use_keywords);
 334   m_dlg->pbChange->setEnabled(use_keywords && itemActive);
 335   m_dlg->pbDelete->setEnabled(use_keywords && itemActive);
 336   m_dlg->lbDelimiter->setEnabled (use_keywords);
 337   m_dlg->cmbDelimiter->setEnabled (use_keywords);
 338   m_dlg->lbDefaultEngine->setEnabled (use_keywords);
 339   m_dlg->cmbDefaultEngine->setEnabled (use_keywords);
 340 }
 341
 342 void FilterOptions::addSearchProvider()
 343 {
 344   SearchProviderDialog dlg(0, this);
 345
 346   if (dlg.exec())
 347   {
 348       m_dlg->lvSearchProviders->setCurrentItem(displaySearchProvider(dlg.provider()));
 349       configChanged();
 350   }
 351 }
 352
 353 void FilterOptions::changeSearchProvider()
 354 {
 355   SearchProviderItem *item = dynamic_cast<SearchProviderItem *>(m_dlg->lvSearchProviders->currentItem());
 356   Q_ASSERT(item);
 357
 358   SearchProviderDialog dlg(item->provider(), this);
 359
 360   if (dlg.exec())
 361   {
 362     m_dlg->lvSearchProviders->setCurrentItem(displaySearchProvider(dlg.provider()));
 363     configChanged();
 364   }
 365 }
 366
 367 void FilterOptions::deleteSearchProvider()
 368 {
 369   SearchProviderItem *item = dynamic_cast<SearchProviderItem *>(m_dlg->lvSearchProviders->currentItem());
 370   Q_ASSERT(item);
 371
 372   // Update the combo box to go to None if the fallback was deleted.
 373   int current = m_dlg->cmbDefaultEngine->currentIndex();
 374   for (int i = 1, count = m_dlg->cmbDefaultEngine->count(); i < count; ++i)
 375   {
 376     if (m_dlg->cmbDefaultEngine->itemText(i) == item->provider()->name())
 377     {
 378       m_dlg->cmbDefaultEngine->removeItem(i);
 379       if (i == current)
 380         m_dlg->cmbDefaultEngine->setCurrentIndex(0);
 381       else if (current > i)
 382         m_dlg->cmbDefaultEngine->setCurrentIndex(current - 1);
 383
 384       break;
 385     }
 386   }
 387
 388   if (m_dlg->lvSearchProviders->topLevelItem(current + 1))
 389       m_dlg->lvSearchProviders->setCurrentItem(m_dlg->lvSearchProviders->topLevelItem(current + 1));
 390   else if (m_dlg->lvSearchProviders->topLevelItem(current - 1))
 391       m_dlg->lvSearchProviders->setCurrentItem(m_dlg->lvSearchProviders->topLevelItem(current - 1));
 392
 393   if (!item->provider()->desktopEntryName().isEmpty())
 394       m_deletedProviders.append(item->provider()->desktopEntryName());
 395
 396   delete item;
 397   updateSearchProvider();
 398   configChanged();
 399 }
 400
 401 void FilterOptions::updateSearchProvider()
 402 {
 403   m_dlg->pbChange->setEnabled(m_dlg->lvSearchProviders->currentItem());
 404   m_dlg->pbDelete->setEnabled(m_dlg->lvSearchProviders->currentItem());
 405 }
 406
 407 SearchProviderItem *FilterOptions::displaySearchProvider(SearchProvider *p, bool fallback)
 408 {
 409   // Show the provider in the list.
 410   SearchProviderItem *item = 0L;
 411
 412   QTreeWidgetItemIterator it(m_dlg->lvSearchProviders);
 413   while (*it)
 414   {
 415     if ((*it)->text(0) == p->name())
 416     {
 417       item = dynamic_cast<SearchProviderItem *>(*it);
 418       Q_ASSERT(item);
 419       break;
 420     }
 421     ++it;
 422   }
 423
 424   if (item)
 425     item->update ();
 426   else
 427   {
 428     // Put the name in the default search engine combo box.
 429     int itemCount;
 430     int totalCount = m_dlg->cmbDefaultEngine->count();
 431
 432     item = new SearchProviderItem(m_dlg->lvSearchProviders, p);
 433
 434     if (m_favoriteEngines.contains(p->desktopEntryName()))
 435        item->setCheckState(0, Qt::Checked);
 436     else
 437        item->setCheckState(0, Qt::Unchecked);
 438
 439     for (itemCount = 1; itemCount < totalCount; itemCount++)
 440     {
 441       if (m_dlg->cmbDefaultEngine->itemText(itemCount) > p->name())
 442       {
 443         int currentItem = m_dlg->cmbDefaultEngine->currentIndex();
 444         m_dlg->cmbDefaultEngine->insertItem(itemCount, p->name());
 445         m_defaultEngineMap[p->name ()] = p->desktopEntryName ();
 446         if (currentItem >= itemCount)
 447           m_dlg->cmbDefaultEngine->setCurrentIndex(currentItem+1);
 448         break;
 449       }
 450     }
 451
 452     // Append it to the end of the list...
 453     if (itemCount == totalCount)
 454     {
 455       m_dlg->cmbDefaultEngine->insertItem(itemCount, p->name());
 456       m_defaultEngineMap[p->name ()] = p->desktopEntryName ();
 457     }
 458
 459     if (fallback)
 460       m_dlg->cmbDefaultEngine->setCurrentIndex(itemCount);
 461
 462   if (!(*it))
 463     m_dlg->lvSearchProviders->sortItems(0, Qt::AscendingOrder);
 464   }
 465
 466   return item;
 467 }
 468
 469 #include "ikwsopts.moc"