f61266e6dc9c3d062c20463f079d7f649e962965
[mdictionary] / src / mdictionary / 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 "ConfigGenerator.h"
30 class ConfigGenerator;
31 #include <QDebug>
32
33 int Backbone::_searchLimit;
34
35 // Sadly QtConcurrent::mapped doesn't let me use something like calling method of
36 // some class with supplied argument; so I have to sin against art and put
37 // global function and variable so I could supply function with some parameter
38 QString mappedSearch;
39 QList<Translation*> mapSearch(CommonDictInterface *dict) {
40     if(dict)
41         return dict->searchWordList(mappedSearch, Backbone::_searchLimit);
42     return QList<Translation*>();
43 }
44
45
46
47 /*! Smart pointer (kind of) for translation object
48
49     QtConcurrent::mapped uses collection of data and one function, what I need is
50     to map single data object to method calls for multiple objects. TranslationPtr
51     is an attempt to store method call as a data -> moreover QtConcurrent allows only for
52     methods without any parameters so TranslationPtr is created with Translation
53     object -> ready to call toHtml() for supplied Translation.
54
55     Another thing is that QtConcurrent doesn't like pointers in data collection
56     so TranslationPtr is a way to hide real translation object (pointer to object)
57     */
58 class TranslationPtr {
59     Translation* _tr;
60 public:
61     TranslationPtr(Translation* tr) :_tr(tr) {}
62
63     /*! \return translation text for corresponding Translation object */
64     QString toHtml() const {
65         QString trans;
66         trans = _tr->toHtml();
67         return trans;
68
69     }
70 };
71
72 void Backbone::init() {
73
74    _dictNum = 0;
75    _dir = QDir::homePath() + "/.mdictionary/";
76    if(!QDir(_dir).exists())
77        QDir().mkdir(_dir);
78
79   _configPath = _dir + "mdictionary.config";
80   _pluginPath = "/usr/lib/mdictionary/plugins/";
81
82    //Install default config files
83    ConfigGenerator confGen;
84    confGen.generateCss(_dir + "style.css");
85    confGen.generateDefaultConfig(_configPath);
86
87    loadPrefs(_configPath);
88
89    loadPlugins();
90
91    loadDicts(_configPath);
92
93    connect(&_resultWatcher, SIGNAL(finished()), this, SLOT(translationReady()));
94    connect(&_htmlResultWatcher, SIGNAL(finished()), this,
95            SLOT(htmlTranslationReady()));
96    connect(&_bookmarkWatcher, SIGNAL(finished()), this,
97            SLOT(bookmarksListReady()));
98    connect(&_bookmarkSearchWatcher, SIGNAL(finished()), this,
99            SLOT(translationReady()));
100
101    // In common opinion perfect thread count is cores_number+1 (in qt perfect
102    // thread count is set to cores number)
103    QThreadPool::globalInstance()->setMaxThreadCount(
104            QThreadPool::globalInstance()->maxThreadCount()+1);
105
106    _history = new History(_historyLen, this);
107 }
108
109
110
111 Backbone::Backbone(QString pluginPath, QString configPath, bool dry,
112                    QObject *parent)
113     : QObject(parent)
114 {
115     _pluginPath = pluginPath;
116     _configPath = configPath;
117
118     dryRun = false;
119     if(dry)
120         dryRun = true;
121     init();
122 }
123
124
125
126 Backbone::~Backbone()
127 {
128     QListIterator<CommonDictInterface*> it(_dicts.keys());
129
130     while(it.hasNext())
131         delete it.next();
132
133     it = QListIterator<CommonDictInterface*>(_plugins);
134     while(it.hasNext())
135         delete it.next();
136
137     QHashIterator<QString, Translation*> it2(_result);
138     while(it2.hasNext())
139         delete it2.next().value();
140
141 }
142
143
144
145
146 Backbone::Backbone(const Backbone &b) :QObject(b.parent()) {
147     init();
148     _dicts = QHash<CommonDictInterface*, bool > (b._dicts);
149     _plugins = QList<CommonDictInterface* > (b._plugins);
150     _result = QHash<QString, Translation* > (b._result);
151     _searchLimit = b.searchLimit();
152 }
153
154
155
156
157 int Backbone::searchLimit() const {
158     return _searchLimit;
159 }
160
161
162
163 QHash<CommonDictInterface*, bool > Backbone::getDictionaries() {
164     return _dicts;
165 }
166
167
168
169 QList<CommonDictInterface* > Backbone::getPlugins() {
170     return _plugins;
171 }
172
173
174
175 History* Backbone::history() {
176     return _history;
177 }
178
179
180
181 QMultiHash<QString, Translation*> Backbone::result() {
182     return _result;
183 }
184
185
186
187 void Backbone::stopSearching() {
188     if(stopped)
189         return;
190
191     foreach(CommonDictInterface* dict, _dicts.keys())
192         dict->stop();
193     stopped = true;
194     _innerHtmlResult.cancel();
195     _innerResult.cancel();
196     Q_EMIT searchCanceled();
197 }
198
199
200
201 void Backbone::search(QString word){
202     _result.clear();
203     mappedSearch = word.toLower();
204
205     stopped = false;
206
207     // When dictFin and bookmarkFin is set to true then translationReady()
208     // signal is emitted see translationReady(),
209     // so when searching only in one of them, corresponding *Fin is set to false
210     // and other to true so program is waiting only for one translation
211     dictFin = !_searchDicts;
212     bookmarkFin = !_searchBookmarks;
213
214     if(!_searchDicts && !_searchBookmarks) {
215         Q_EMIT ready();
216         Q_EMIT notify(Notify::Warning, tr("You have to specify where You want "
217                 "to look for translations"));
218     }
219
220     if (_searchDicts) {
221         _innerResult = QtConcurrent::mapped(activeDicts(), mapSearch);
222         _resultWatcher.setFuture(_innerResult);
223     }
224
225     if(_searchBookmarks) {
226         _innerBookmarks = QtConcurrent::run(_bookmarks,
227                 &Bookmarks::searchWordList, word);
228         _bookmarkSearchWatcher.setFuture(_innerBookmarks);
229     }
230 }
231
232
233
234 void Backbone::selectedDictionaries(QList<CommonDictInterface* > activeDicts) {
235     foreach(CommonDictInterface* dict, _dicts.keys())
236         if(activeDicts.contains(dict))
237             _dicts[dict] = 1;
238         else
239             _dicts[dict] = 0;
240     dictUpdated();
241  }
242
243
244
245 void Backbone::addDictionary(CommonDictInterface *dict, bool active) {
246     addInternalDictionary(dict,active);
247     dictUpdated();
248 }
249
250
251
252 void Backbone::addInternalDictionary(CommonDictInterface* dict, bool active) {
253     if(dict) {
254         dict->setHash(++_dictNum); // Hash must be uniqe in every session but not between
255         _dicts[dict] = active;
256         connect(dict, SIGNAL(settingsChanged()), this, SLOT(dictUpdated()));
257         connect(dict, SIGNAL(notify(Notify::NotifyType,QString)), this,
258             SIGNAL(notify(Notify::NotifyType,QString)));
259     }
260 }
261
262
263
264  void Backbone::removeDictionary(CommonDictInterface *dict) {
265      _dicts.remove(dict);
266      if(dict) {
267         dict->clean();
268         delete dict;
269      }
270      dictUpdated();
271  }
272
273
274
275  void Backbone::quit() {
276     stopSearching();
277     Q_EMIT closeOk();
278 }
279
280
281
282 void Backbone::translationReady() {
283     bool changed = 0; // prevents from doubling ready() signal, when both if's are
284                       //  executed in one translationReady() call then second
285                       // translationReady() call doubles ready*() emit
286
287     if(!dictFin && _innerResult.isFinished()) {
288         changed = 1;
289         dictFin = 1;
290         QFutureIterator<QList<Translation*> > it(_innerResult);
291
292         while(it.hasNext()) {
293             QList<Translation* > list = it.next();
294             foreach(Translation* trans, list) {
295                 if(!trans)
296                     continue;
297                 if(!_searchBookmarks)
298                     trans->setBookmark(_bookmarks.
299                             inBookmarks(trans->key()));
300                 _result.insert(trans->key().toLower(), trans);
301            }
302         }
303     }
304
305     if(!bookmarkFin && _innerBookmarks.isFinished()) {
306         changed = 1;
307         bookmarkFin = 1;
308         QList<Translation*> list = _innerBookmarks.result();
309
310         foreach(Translation* trans, list)
311                 _result.insert(trans->key().toLower(), trans);
312     }
313
314     if(!stopped && bookmarkFin && dictFin && changed) {
315         Q_EMIT ready();
316     }
317 }
318
319
320
321
322 QStringList Backbone::getFilesFromDir(QString dir, QStringList nameFilter) {
323     QDir plug(QDir::toNativeSeparators(dir));
324     if(!plug.exists()) {
325         qDebug() << plug.absolutePath() << " folder doesn't exist";
326         Q_EMIT notify(Notify::Warning,
327                 tr("%1 folder doesn't exist.").arg(plug.path()));
328         return QStringList();
329     }
330     plug.setFilter(QDir::Files);
331     QStringList list = plug.entryList(nameFilter);
332
333     for(int i = 0; i < list.size(); i++)
334         list[i] = plug.absoluteFilePath(list.at(i));
335     return list;
336 }
337
338
339 void Backbone::loadPlugins() {
340     if(dryRun)
341         return;
342     QStringList nameFilter;
343     nameFilter << "*.so" << "*.so.*";
344     QStringList files = getFilesFromDir(_pluginPath, nameFilter);
345
346     foreach(QString file, files) {
347         QPluginLoader loader(file);
348         if(!loader.load()) {
349             Q_EMIT notify(Notify::Error,
350                     tr("%1 plugin cannot be loaded: %2.")
351                     .arg(file).arg(loader.errorString()));
352             continue;
353         }
354         QObject *pl = loader.instance();
355
356         bool exists = 0;
357         CommonDictInterface *plugin = qobject_cast<CommonDictInterface*>(pl);
358         foreach(CommonDictInterface* pl, _plugins)
359             if(pl->type() == plugin->type()) {
360                 exists = 1;
361                 break;
362            }
363         if(!exists) {
364             _plugins.append(plugin);
365             plugin->retranslate();
366         }
367     }
368 }
369
370
371
372 CommonDictInterface* Backbone::plugin(QString type) {
373     foreach(CommonDictInterface* plugin, _plugins)
374         if(plugin->type() == type)
375             return plugin;
376     return 0;
377 }
378
379
380
381 void Backbone::loadPrefs(QString fileName) {
382     if(dryRun)
383         return;
384     QFileInfo file(QDir::toNativeSeparators(fileName));
385     QDir confDir(file.dir());
386     if(!confDir.exists()){
387         qDebug() << "Configuration file doesn't exist ("
388                 << file.filePath() << ")";
389         Q_EMIT notify(Notify::Warning,
390                 tr("%1 configuration file doesn't exist.")
391                 .arg(file.filePath()));
392         return;
393     }
394     QSettings set(file.filePath(), QSettings::IniFormat);
395     _pluginPath = set.value("general/plugin_path", _pluginPath).toString();
396     _historyLen = set.value("general/history_size", 10).toInt();
397     _searchLimit = set.value("general/search_limit", 15).toInt();
398     _searchBookmarks = set.value("general/search_bookmarks",1).toBool();
399     _searchDicts = set.value("general/search_dictionaries",1).toBool();
400     _zoom = set.value("general/zoom", 1.0).toReal();
401 }
402
403
404
405 void Backbone::savePrefs(QSettings *set) {
406     if(dryRun)
407         return;
408     set->setValue("general/plugin_path", _pluginPath);
409     set->setValue("general/history_size", _historyLen);
410     set->setValue("general/search_limit", _searchLimit);
411     set->setValue("general/search_bookmarks", _searchBookmarks);
412     set->setValue("general/search_dictionaries", _searchDicts);
413     set->setValue("general/zoom", _zoom);
414 }
415
416
417
418 void Backbone::loadDicts(QString fileName) {
419     if(dryRun)
420         return;
421
422     QFileInfo file(QDir::toNativeSeparators(fileName));
423     QDir confDir(file.dir());
424     if(!confDir.exists()){
425         qDebug() << "Configuration file doesn't exist ("
426                 << file.filePath() << ")";
427         Q_EMIT notify(Notify::Warning,
428                 tr("%1 configuration file doesn't exist.")
429                 .arg(file.filePath()));
430         return;
431     }
432
433     QSettings set(file.filePath(), QSettings::IniFormat);
434     QStringList dicts = set.childGroups();
435     foreach(QString dict, dicts) {
436         if(!dict.contains("dictionary_"))
437             continue;
438         CommonDictInterface* plug = plugin
439                                     (set.value(dict + "/type", "").toString());
440         if(!plug) {
441             qDebug() << "Config file error: "
442                     << set.value(dict + "/type", "").toString()
443                     << " doesn't exist";
444             Q_EMIT notify(Notify::Warning,
445                     tr("Configuration file error. %2 plugin doesn't exist.")
446                     .arg(set.value(dict + "/type", "").toString()));
447             continue;
448         }
449         Settings* plugSet = new Settings();
450         set.beginGroup(dict);
451         QStringList items = set.childKeys();
452         foreach(QString item, items) {
453             plugSet->setValue(item, set.value(item, "").toString());
454         }
455         bool active = set.value("active",1).toBool();
456
457         set.endGroup();
458         addInternalDictionary(plug->getNew(plugSet), active);
459         delete plugSet;
460     }
461 }
462
463
464
465 void Backbone::dictUpdated() {
466     if(dryRun)
467         return;
468
469     // For convienence this function is called for each change in dictionaries
470     // and each call dumps configuration for all dictionaries into file.
471     // Maybe better way would be to store new/changed configuration but
472     // parsing settings file and figuring out what was changed, in my opinion,
473     // would take more time
474     _history->setMaxSize(_historyLen);
475     QFileInfo file(QDir::toNativeSeparators(_configPath));
476     QDir confDir(file.dir());
477     if(!confDir.exists())
478         confDir.mkpath(file.dir().path());
479     QSettings set(file.filePath(), QSettings::IniFormat);
480     set.clear();
481
482     savePrefs(&set);
483
484     foreach(CommonDictInterface* dict, _dicts.keys()){
485         if(!dict || !dict->settings())
486             continue;
487         saveState(&set, dict->settings(), _dicts[dict], dict->hash());
488     }
489 }
490
491
492
493 void Backbone::saveState(QSettings* set, Settings* plugSet, bool active
494                          , uint hash) {
495     if(dryRun)
496         return;
497     if(!set || !plugSet)
498         return;
499
500     QString section;
501     section.append(QString("dictionary_%1").arg(hash));
502     QList<QString> keys = plugSet->keys();
503     foreach(QString key, keys)
504         set->setValue(section + "/" + key, plugSet->value(key));
505     set->setValue(section + "/active", active);
506 }
507
508
509
510 QStringList Backbone::htmls() {
511     return _htmlResult;
512 }
513
514
515
516 void Backbone::searchHtml(QList<Translation *> translations) {
517     _htmlResult.clear();
518
519     QList<TranslationPtr> dummy;
520     stopped = false;
521     foreach(Translation* tr, translations) {
522          if(containsDict(tr->dict()) || !tr->dict())
523             dummy.append(TranslationPtr(tr));
524   /*      foreach(CommonDictInterface* dict, activeDicts()) {
525             Translation* trans = dict->getTranslationFor(tr->key());
526             if(trans)
527                 dummy.append(TranslationPtr(trans));
528         } */
529     }
530     if(translations.size()>0) {
531         Translation *tr = translations.at(0);
532         foreach(CommonDictInterface* dict, activeDicts()) {
533             Translation* trans = dict->getTranslationFor(tr->key());
534             if(trans)
535                 dummy.append(TranslationPtr(trans));
536         }
537     }
538
539    _innerHtmlResult = QtConcurrent::mapped(dummy,
540                                             &TranslationPtr::toHtml);
541    _htmlResultWatcher.setFuture(_innerHtmlResult);
542 }
543
544
545
546 void Backbone::htmlTranslationReady() {
547
548     QFutureIterator<QString> it(_innerHtmlResult);
549     QSet<QString> uniqe;
550     while(it.hasNext())
551         uniqe.insert(it.next());
552     _htmlResult.clear();
553     _htmlResult = uniqe.toList();
554
555     if(!stopped)
556         Q_EMIT htmlReady();
557
558 }
559
560
561 QList<CommonDictInterface*> Backbone::activeDicts() {
562     QList<CommonDictInterface*>res;
563     foreach(CommonDictInterface* dict, _dicts.keys())
564         if(_dicts[dict])
565             res.append(dict);
566     return res;
567
568 }
569
570
571
572 void Backbone::bookmarksListReady() {
573    _bookmarksResult = _innerBookmarks.result();
574    Q_EMIT bookmarksReady();
575 }
576
577
578
579
580 void Backbone::setSettings(Settings *settings) {
581     _historyLen = settings->value("history_size").toInt();
582     _searchLimit = settings->value("search_limit").toInt();
583     if(settings->value("search_dictionaries") == "true")
584         _searchDicts = 1;
585     else
586         _searchDicts = 0;
587     if(settings->value("search_bookmarks") == "true")
588         _searchBookmarks = 1;
589     else
590         _searchBookmarks = 0;
591     _zoom = settings->value("zoom").toFloat();
592     if(!_zoom)
593         _zoom ++;
594
595     dictUpdated();
596     if(settings)
597         delete settings;
598 }
599
600
601
602
603 Settings* Backbone::settings() {
604     Settings * settings = new Settings();
605     settings->setValue("history_size", QString("%1").arg(_historyLen));
606     settings->setValue("search_limit", QString("%1").arg(_searchLimit));
607     settings->setValue("zoom", QString("%1").arg(_zoom));
608     if(_searchBookmarks)
609         settings->setValue("search_bookmarks", "true");
610     else
611         settings->setValue("search_bookmarks", "false");
612
613     if(_searchDicts)
614         settings->setValue("search_dictionaries", "true");
615     else
616         settings->setValue("search_dictionaries", "false");
617     return settings;
618 }
619
620
621 bool Backbone::containsDict(uint hash) const {
622     QHashIterator<CommonDictInterface*, bool> it(_dicts);
623     if (!hash)
624         return false;
625     while(it.hasNext())
626         if(it.next().key()->hash() == hash)
627             return true;
628     return false;
629 }