Merged and fixed backbone settings
[mdictionary] / trunk / src / base / backbone / backbone.cpp
1 /*******************************************************************************
2
3     This file is part of mDictionary.
4
5     mDictionary 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 3 of the License, or
8     (at your option) any later version.
9
10     mDictionary 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 mDictionary.  If not, see <http://www.gnu.org/licenses/>.
17
18     Copyright 2010 Comarch S.A.
19
20 *******************************************************************************/
21 /*! /file backbone.cpp
22 \brief Backbone/core main file \see Backbone
23
24
25 \author Bartosz Szatkowski <bulislaw@linux.com>
26 */
27
28 #include "backbone.h"
29 #include <QDebug>
30
31 QString mappedSearch;
32 QList<Translation*> mapSearch(CommonDictInterface *dict) {
33     if(dict)
34         return dict->searchWordList(mappedSearch, 15);
35     return QList<Translation*>();
36 }
37
38 class TranslationPtr {
39     Translation* _tr;
40 public:
41     TranslationPtr(Translation* tr) :_tr(tr) {}
42     QString toHtml() const {
43         QString trans;
44         trans = _tr->toHtml();
45         return trans;
46
47     }
48 };
49
50 void Backbone::init() {
51
52    if(!_configPath.size())
53        _configPath = QDir::homePath() + "/.mdictionary/mdictionary.config";
54    if(!_defaultConfigPath.size())
55        _defaultConfigPath = QDir::homePath() + "/.mdictionary/mdictionary.defaults";
56    if(!_pluginPath.size())
57        _pluginPath = "/usr/lib/mdictionary";
58    _historyLen = 10;
59    _searchLimit = 15;
60
61    loadPrefs(_defaultConfigPath);
62    _defaultPluginPath = _pluginPath;
63    _defaultHistoryLen = _historyLen;
64    _defaultSearchLimit = _searchLimit;
65    loadPrefs(_configPath);
66
67    loadPlugins();
68
69    loadDicts(_defaultConfigPath, true);
70    loadDicts(_configPath);
71
72    connect(&_resultWatcher, SIGNAL(finished()), this, SLOT(translationReady()));
73    connect(&_htmlResultWatcher, SIGNAL(finished()), this,
74            SLOT(htmlTranslationReady()));
75    connect(&_bookmarkWatcher, SIGNAL(finished()), this,
76            SLOT(bookmarksListReady()));
77    connect(&_bookmarkSearchWatcher, SIGNAL(finished()), this,
78            SLOT(translationReady()));
79
80    QThreadPool::globalInstance()->setMaxThreadCount(
81            QThreadPool::globalInstance()->maxThreadCount()+1);
82
83    _history = new History(5, this);
84 }
85
86
87
88 Backbone::Backbone(QString pluginPath, QString configPath, bool dry,
89                    QObject *parent)
90     : QObject(parent)
91 {
92     _pluginPath = pluginPath;
93     _configPath = configPath;
94     _defaultConfigPath = configPath;
95     dryRun = false;
96     if(dry)
97         dryRun = true;
98     init();
99 }
100
101
102
103 Backbone::~Backbone()
104 {
105     QListIterator<CommonDictInterface*> it(_dicts.keys());
106
107     while(it.hasNext())
108         delete it.next();
109
110     it = QListIterator<CommonDictInterface*>(_plugins);
111     while(it.hasNext())
112         delete it.next();
113
114     QHashIterator<QString, Translation*> it2(_result);
115     while(it2.hasNext())
116         delete it2.next().value();
117
118 }
119
120
121
122
123 Backbone::Backbone(const Backbone &b) :QObject(b.parent()) {
124     _dicts = QHash<CommonDictInterface*, bool > (b._dicts);
125     _plugins = QList<CommonDictInterface* > (b._plugins);
126     _result = QHash<QString, Translation* > (b._result);
127     _searchLimit = b.searchLimit();
128 }
129
130
131
132
133 int Backbone::searchLimit() const {
134     return _searchLimit;
135 }
136
137
138
139 QHash<CommonDictInterface*, bool > Backbone::getDictionaries() {
140     return _dicts;
141 }
142
143
144
145 QList<CommonDictInterface* > Backbone::getPlugins() {
146     return _plugins;
147 }
148
149
150
151 History* Backbone::history() {
152     return _history;
153 }
154
155
156
157 QMultiHash<QString, Translation*> Backbone::result() {
158     return _result;
159 }
160
161
162
163 void Backbone::stopSearching() {
164     if(stopped)
165         return;
166
167     foreach(CommonDictInterface* dict, _dicts.keys())
168         dict->stop();
169     stopped = true;
170     _innerHtmlResult.cancel();
171     _innerResult.cancel();
172     Q_EMIT searchCanceled();
173 }
174
175
176
177 void Backbone::search(QString word){
178     _result.clear();
179     mappedSearch = word.toLower();
180
181     stopped = false;
182     dictFin = !_searchDicts;
183     bookmarkFin = !_searchBookmarks;
184
185     if (_searchDicts) {
186         _innerResult = QtConcurrent::mapped(activeDicts(), mapSearch);
187         _resultWatcher.setFuture(_innerResult);
188     }
189
190     if(_searchBookmarks) {
191         _innerBookmarks = QtConcurrent::run(_bookmarks,
192                 &Bookmarks::searchWordList, word);
193         _bookmarkSearchWatcher.setFuture(_innerBookmarks);
194     }
195 }
196
197
198
199 void Backbone::selectedDictionaries(QList<CommonDictInterface* > activeDicts) {
200     foreach(CommonDictInterface* dict, _dicts.keys())
201         if(activeDicts.contains(dict))
202             _dicts[dict] = 1;
203         else
204             _dicts[dict] = 0;
205     dictUpdated();
206  }
207
208
209
210 void Backbone::addDictionary(CommonDictInterface *dict, bool active) {
211     addInternalDictionary(dict,active);
212     dictUpdated();
213 }
214
215
216
217  void Backbone::addInternalDictionary(CommonDictInterface* dict, bool active) {
218      dict->setHash(_dicts.size()+1);
219      _dicts[dict] = active;
220      connect(dict, SIGNAL(settingsChanged()), this, SLOT(dictUpdated()));
221  }
222
223  void Backbone::removeDictionary(CommonDictInterface *dict) {
224      _dicts.remove(dict);
225      dictUpdated();
226
227  }
228
229
230
231  void Backbone::quit() {
232     stopSearching();
233     Q_EMIT closeOk();
234 }
235
236
237
238 void Backbone::translationReady() {
239     if(!dictFin && _innerResult.isFinished()) {
240         dictFin = 1;
241         QFutureIterator<QList<Translation*> > it(_innerResult);
242
243         while(it.hasNext()) {
244             QList<Translation* > list = it.next();
245             foreach(Translation* trans, list)
246                 _result.insert(trans->key().toLower(), trans);
247         }
248     }
249
250     if(!bookmarkFin && _innerBookmarks.isFinished()) {
251         bookmarkFin = 1;
252         QList<Translation*> list = _innerBookmarks.result();
253
254         foreach(Translation* trans, list)
255                 _result.insert(trans->key().toLower(), trans);
256     }
257
258     if(!stopped && bookmarkFin && dictFin)
259         Q_EMIT ready();
260 }
261
262 QStringList Backbone::getFilesFromDir(QString dir, QStringList nameFilter) {
263     QDir plug(QDir::toNativeSeparators(dir));
264     if(!plug.exists()) {
265         qDebug() << plug.absolutePath() << " folder dosen't exists";
266         return QStringList();
267     }
268     plug.setFilter(QDir::Files);
269     QStringList list = plug.entryList(nameFilter);
270
271     for(int i = 0; i < list.size(); i++)
272         list[i] = plug.absoluteFilePath(list.at(i));
273     return list;
274 }
275
276
277 void Backbone::loadPlugins() {
278     if(dryRun)
279         return;
280     QStringList nameFilter;
281     nameFilter << "*.so";
282     QStringList files = getFilesFromDir(_pluginPath, nameFilter);
283
284     foreach(QString file, files) {
285         QPluginLoader loader(file);
286         if(!loader.load()) {
287             qDebug()<< file << " " << loader.errorString();
288             continue;
289         }
290         QObject *pl = loader.instance();
291
292         CommonDictInterface *plugin = qobject_cast<CommonDictInterface*>(pl);
293         _plugins.append(plugin);
294     }
295 }
296
297
298
299 CommonDictInterface* Backbone::plugin(QString type) {
300     foreach(CommonDictInterface* plugin, _plugins)
301         if(plugin->type() == type)
302             return plugin;
303     return 0;
304 }
305
306
307
308 void Backbone::loadPrefs(QString fileName) {
309     if(dryRun)
310         return;
311     QFileInfo file(QDir::toNativeSeparators(fileName));
312     QDir confDir(file.dir());
313     if(!confDir.exists()){
314         qDebug() << "Configuration file dosn't exists ("
315                 << file.filePath() << ")";
316         return;
317     }
318     QSettings set(file.filePath(), QSettings::IniFormat);
319     _pluginPath = set.value("general/plugin_path", _pluginPath).toString();
320     _historyLen = set.value("general/history_size", 10).toInt();
321     _searchLimit = set.value("general/search_limit", 15).toInt();
322     _searchBookmarks = set.value("general/search_bookmarks",1).toBool();
323     _searchDicts = set.value("general/search_dictionaries",1).toBool();
324 }
325
326
327
328 void Backbone::savePrefs(QSettings *set) {
329     if(dryRun)
330         return;
331     set->setValue("general/plugin_path", _pluginPath);
332     set->setValue("general/history_size", _historyLen);
333     set->setValue("general/search_limit", _searchLimit);
334     set->setValue("general/search_bookmarks", _searchBookmarks);
335     set->setValue("general/search_dictionaries", _searchDicts);
336 }
337
338
339
340 void Backbone::saveDefaultPrefs(QSettings *set) {
341     if(dryRun)
342         return;
343     set->setValue("general/plugin_path", _defaultPluginPath);
344     set->setValue("general/history_size", _defaultHistoryLen);
345     set->setValue("general/search_limit", _defaultSearchLimit);
346 }
347
348
349
350 void Backbone::loadDicts(QString fileName, bool _default) {
351     if(dryRun)
352         return;
353     QFileInfo file(QDir::toNativeSeparators(fileName));
354     QDir confDir(file.dir());
355     if(!confDir.exists()){
356         qDebug() << "Configuration file dosn't exists ("
357                 << file.filePath() << ")";
358         return;
359     }
360
361     QSettings set(file.filePath(), QSettings::IniFormat);
362     QStringList dicts = set.childGroups();
363     foreach(QString dict, dicts) {
364         if(!dict.contains("dictionary_"))
365             continue;
366         CommonDictInterface* plug = plugin
367                                     (set.value(dict + "/type", "").toString());
368         if(!plug) {
369             qDebug() << "Config file error: "
370                     << set.value(dict + "/type", "").toString()
371                     << " dosen't exists";
372             continue;
373         }
374         Settings* plugSet = new Settings();
375         set.beginGroup(dict);
376         QStringList items = set.childKeys();
377         foreach(QString item, items) {
378             plugSet->setValue(item, set.value(item, "").toString());
379         }
380         bool active = set.value("active",1).toBool();
381
382         if(_default)
383             plugSet->setValue("_default_", "true");
384
385         set.endGroup();
386         addInternalDictionary(plug->getNew(plugSet), active);
387     }
388 }
389
390
391
392 void Backbone::dictUpdated() {
393     if(dryRun)
394         return;
395     _history->setMaxSize(_historyLen);
396     QFileInfo file(QDir::toNativeSeparators(_configPath));
397     QDir confDir(file.dir());
398     if(!confDir.exists())
399         confDir.mkpath(file.dir().path());
400     QSettings set(file.filePath(), QSettings::IniFormat);
401     set.clear();
402
403     QFileInfo defFile(QDir::toNativeSeparators(_defaultConfigPath));
404     QDir defConfDir(defFile.dir());
405     if(!defConfDir.exists())
406         defConfDir.mkpath(defFile.dir().path());
407     QSettings defSet(defFile.filePath(), QSettings::IniFormat);
408     defSet.clear();
409     savePrefs(&set);
410     saveDefaultPrefs(&defSet);
411
412     foreach(CommonDictInterface* dict, _dicts.keys()){
413         if(!dict || !dict->settings())
414             continue;
415         if(!dict->settings()->keys().contains("_default_"))
416             saveState(&set, dict->settings(), _dicts[dict], dict->hash());
417         else
418             saveState(&defSet, dict->settings(), _dicts[dict], dict->hash());
419     }
420 }
421
422
423
424 void Backbone::saveState(QSettings* set, Settings* plugSet, bool active
425                          , uint hash) {
426     if(dryRun)
427         return;
428     if(!set || !plugSet)
429         return;
430     QString section;
431     section.append(QString("dictionary_%1").arg(hash));
432     QList<QString> keys = plugSet->keys();
433     foreach(QString key, keys)
434         set->setValue(section + "/" + key, plugSet->value(key));
435     set->setValue(section + "/active", active);
436 }
437
438
439
440 QStringList Backbone::htmls() {
441     return _htmlResult;
442 }
443
444
445
446 void Backbone::searchHtml(QList<Translation *> translations) {
447     _htmlResult.clear();
448
449     QList<TranslationPtr> dummy;
450     stopped = false;
451     foreach(Translation* tr, translations)
452         dummy.append(TranslationPtr(tr));
453
454    _innerHtmlResult = QtConcurrent::mapped(dummy,
455                                             &TranslationPtr::toHtml);
456    _htmlResultWatcher.setFuture(_innerHtmlResult);
457 }
458
459 void Backbone::htmlTranslationReady() {
460
461     QFutureIterator<QString> it(_innerHtmlResult);
462     while(it.hasNext())
463        _htmlResult.append(it.next());
464
465     if(!stopped)
466         Q_EMIT htmlReady();
467
468 }
469
470
471 QList<CommonDictInterface*> Backbone::activeDicts() {
472     QList<CommonDictInterface*>res;
473     foreach(CommonDictInterface* dict, _dicts.keys())
474         if(_dicts[dict])
475             res.append(dict);
476     return res;
477
478 }
479
480
481
482 void Backbone::bookmarksListReady() {
483    _bookmarksResult = _innerBookmarks.result();
484    Q_EMIT bookmarksReady();
485 }
486
487
488
489
490 void Backbone::setSettings(Settings *settings) {
491     _historyLen = settings->value("history_size").toInt();
492     _searchLimit = settings->value("search_limit").toInt();
493     if(settings->value("search_dictionaries") == "true")
494         _searchDicts = 1;
495     else
496         _searchDicts = 0;
497     if(settings->value("search_bookmarks") == "true")
498         _searchBookmarks = 1;
499     else
500         _searchBookmarks = 0;
501     dictUpdated();
502 }
503
504
505
506
507 Settings* Backbone::settings() {
508     Settings * settings = new Settings();
509     settings->setValue("history_size", QString("%1").arg(_historyLen));
510     settings->setValue("search_limit", QString("%1").arg(_searchLimit));
511     if(_searchBookmarks)
512         settings->setValue("search_bookmarks", "true");
513     else
514         settings->setValue("search_bookmarks", "false");
515
516     if(_searchDicts)
517         settings->setValue("search_dictionaries", "true");
518     else
519         settings->setValue("search_dictionaries", "false");
520     return settings;
521 }