dff8863fe5c7bc4db10d98e86e93ac43da3047c7
[mdictionary] / trunk / src / plugins / xdxf / src / xdxfplugin.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
22 /*! \file xdxfplugin.cpp
23 \author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
24 */
25
26 #include "xdxfplugin.h"
27 #include <QDebug>
28 #include "../../../includes/Notify.h"
29
30 XdxfPlugin::XdxfPlugin(QObject *parent) : CommonDictInterface(parent),
31                     _langFrom(""), _langTo(""),_name(""), _infoNote("") {
32     _settings = new Settings();
33     _dictDialog = new XdxfDictDialog(this);
34     cachingDialog = new XdxfCachingDialog(this);
35
36     _settings->setValue("type","xdxf");
37     _icon = QIcon(":/icons/xdxf.png");
38     _wordsCount = -1;
39     stopped = false;
40
41     connect(cachingDialog, SIGNAL(cancelCaching()),
42             this, SLOT(stop()));
43     connect(this, SIGNAL(updateCachingProgress(int,int)),
44             cachingDialog, SLOT(updateCachingProgress(int,int)));
45     initAccents();
46 }
47
48
49 XdxfPlugin::~XdxfPlugin() {
50     delete _settings;
51     delete cachingDialog;
52     delete _dictDialog;
53 }
54
55
56 QString XdxfPlugin::langFrom() const {   
57     return _langFrom;
58 }
59
60
61 QString XdxfPlugin::langTo() const {
62     return  _langTo;
63 }
64
65
66 QString XdxfPlugin::name() const {
67     return  _name;
68 }
69
70
71 QString XdxfPlugin::type() const {
72     return QString("xdxf");
73 }
74
75
76 QString XdxfPlugin::infoNote() const {
77     return  _infoNote;
78 }
79
80
81 QList<Translation*> XdxfPlugin::searchWordList(QString word, int limit) {
82     if( word.indexOf("*")==-1 && word.indexOf("?")==-1 &&
83         word.indexOf("_")==-1 && word.indexOf("%")==-1)
84         word+="*";
85
86     if(isCached())
87         return searchWordListCache(word,limit);
88     return searchWordListFile(word, limit);
89 }
90
91
92 QList<Translation*> XdxfPlugin::searchWordListCache(QString word, int limit) {
93     int i=0;
94     QSet<Translation*> translations;
95     QString cacheFilePath = _settings->value("cache_path");
96
97     db.setDatabaseName(cacheFilePath);
98     if(!QFile::exists(cacheFilePath) || !db.open()) {
99         qDebug() << "Database error" << db.lastError().text() << endl;
100         Q_EMIT notify(Notify::Warning, QString(tr("Cache database cannot be "
101                 "opened for %1 dictionary. Searching in XDXF file. "
102                 "You may want to recache.").arg(name())));
103         _settings->setValue("cached","false");
104         return searchWordListFile(word, limit);
105     }
106     stopped = false;
107     word = word.toLower();
108     word = word.replace("*", "%");
109     word = word.replace("?", "_");
110
111     QSqlQuery cur(db);
112     if(limit !=0)
113         cur.prepare("select word from dict where word like ? or normalized "
114                     "like ? limit ?");
115     else
116         cur.prepare("select word from dict where word like ? or normalized "
117                     "like ?");
118     cur.addBindValue(word);
119     cur.addBindValue(word);
120     if(limit !=0)
121         cur.addBindValue(limit);
122     cur.exec();
123
124     bool in = false;
125     while(cur.next() && (i<limit || limit==0 ) ) {
126         in = true;
127         bool ok=true;
128         Translation *tran;
129         foreach(tran,translations) {
130             if(tran->key().toLower()==cur.value(0).toString().toLower())
131                     ok=false;
132         }
133         if(ok) {  /*add key word to list*/
134             translations.insert(new TranslationXdxf(
135                     cur.value(0).toString().toLower(),
136                     _infoNote, this));
137             i++;
138         }
139     }
140     db.close();
141     return translations.toList();
142 }
143
144
145 QList<Translation*> XdxfPlugin::searchWordListFile(QString word, int limit) {
146     QSet<Translation*> translations;
147     QFile dictionaryFile(_settings->value("path"));
148     word = word.toLower();
149     stopped = false;
150
151     QRegExp regWord(word);
152     regWord.setCaseSensitivity(Qt::CaseInsensitive);
153     regWord.setPatternSyntax(QRegExp::Wildcard);
154
155     /*check xdxf file exist*/
156     if(!QFile::exists(_settings->value("path"))
157                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
158         qDebug()<<"Error: could not open file";
159         Q_EMIT notify(Notify::Warning,
160                 QString(tr("XDXF file cannot be read for %1").arg(name())));
161         return translations.toList();
162     }
163
164     QXmlStreamReader reader(&dictionaryFile);
165     QString readKey;
166     int i=0;
167
168     /*search words list*/
169     while(!reader.atEnd() && !stopped){
170         reader.readNextStartElement();
171         if(reader.name()=="ar") {
172             while(reader.name()!="k" && !reader.atEnd())
173                 reader.readNextStartElement();
174             if(!reader.atEnd())
175                 readKey = reader.readElementText();
176             if((regWord.exactMatch(readKey)
177                     || regWord.exactMatch(removeAccents(readKey)))
178                     && (i<limit || limit==0)) {
179                 bool ok=true;
180                 Translation *tran;
181                 foreach(tran,translations) {
182                     if(tran->key().toLower()==readKey.toLower())
183                         ok=false; /*if key is in the dictionary more that one */
184                 }
185                 if(ok) {  /*add key word to list*/
186                     translations<<(new TranslationXdxf(readKey.toLower(),
187                                     _infoNote,this));
188                     i++;
189                 }
190                 if(i>=limit && limit!=0)
191                     break;
192             }
193         }
194         this->thread()->yieldCurrentThread();
195     }
196     stopped=false;
197     dictionaryFile.close();
198     return translations.toList();
199 }
200
201
202 QString XdxfPlugin::search(QString key) {
203     if(isCached())
204         return searchCache(key);
205     return searchFile(key);
206 }
207
208
209 QString XdxfPlugin::searchCache(QString key) {
210     QString result("");
211     QString cacheFilePath = _settings->value("cache_path");
212     db.setDatabaseName(cacheFilePath);
213     key = key.toLower();
214
215     if(!QFile::exists(cacheFilePath) || !db.open()) {
216         qDebug() << "Database error" << db.lastError().text() << endl;
217         Q_EMIT notify(Notify::Warning, QString(tr("Cache database cannot be "
218                 "opened for %1 dictionary. Searching in XDXF file. "
219                 "You may want to recache.").arg(name())));
220         _settings->setValue("cached","false");
221         return searchFile(key);
222     }
223
224     QSqlQuery cur(db);
225
226     cur.prepare("select translation from dict where word like ?");
227     cur.addBindValue(key);
228     cur.exec();
229     while(cur.next())
230         result += cur.value(0).toString();
231
232     db.close();
233
234     return result;
235
236 }
237
238
239 QString XdxfPlugin::searchFile(QString key) {
240     QFile dictionaryFile(_settings->value("path"));
241     QString resultString("");
242     key = key.toLower();
243
244     /*check xdxf file exist*/
245     if(!QFile::exists(_settings->value("path"))
246                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
247         Q_EMIT notify(Notify::Warning,
248                 QString(tr("XDXF file cannot be read for %1").arg(name())));
249         qDebug()<<"Error: could not open file";
250         return "";
251     }
252
253     QXmlStreamReader reader(&dictionaryFile);
254     QString readKey;
255     bool match =false;
256     stopped = false;
257
258     /*search translations for word*/
259     while (!reader.atEnd()&& !stopped) {
260         reader.readNext();
261         if(reader.tokenType() == QXmlStreamReader::StartElement) {
262             if(reader.name()=="k") {
263                 readKey = reader.readElementText();
264                 if(readKey.toLower()==key.toLower())
265                     match = true;
266             }
267         }
268         if(match) {
269             QString temp("");
270             while(reader.name()!="ar" && !reader.atEnd()) {
271                 if(reader.name()!="" && reader.name()!="k") {
272                     if(reader.tokenType()==QXmlStreamReader::EndElement)
273                         temp+="</";
274                     if(reader.tokenType()==QXmlStreamReader::StartElement)
275                         temp+="<";
276                     temp+=reader.name().toString();
277                     if(reader.name().toString()=="c" &&
278                             reader.tokenType()==QXmlStreamReader::StartElement)
279                        temp= temp + " c=\"" + reader.attributes().
280                                value("c").toString() + "\"";
281                     temp+=">";
282                 }
283                 temp+= reader.text().toString().replace("<","&lt;").
284                         replace(">","&gt;");
285                 reader.readNext();
286             }
287             if(temp.at(0)==QChar('\n'))
288                 temp.remove(0,1);
289             resultString+="<key>" + readKey +"</key>";
290             resultString+="<t>" + temp + "</t>";
291             match=false;
292         }
293         this->thread()->yieldCurrentThread();
294     }
295     stopped=false;
296     dictionaryFile.close();
297     return resultString;
298 }
299
300
301 void XdxfPlugin::stop() {
302     stopped=true;
303 }
304
305
306 DictDialog* XdxfPlugin::dictDialog() {
307      return _dictDialog;
308 }
309
310
311 CommonDictInterface* XdxfPlugin::getNew(const Settings *settings) const {
312     XdxfPlugin *plugin = new XdxfPlugin(); // VAL: ??
313     if(settings){
314         plugin->setSettings(settings);
315     }
316     delete settings;
317     return  plugin;
318 }
319
320
321 bool XdxfPlugin::isAvailable() const {
322     return true;
323 }
324
325
326 void XdxfPlugin::setHash(uint _hash) {
327     this->_hash=_hash;
328 }
329
330
331 uint XdxfPlugin::hash() const {
332    return _hash;
333 }
334
335
336 Settings* XdxfPlugin::settings() {
337 /*
338     Settings *returnSettings=new Settings;
339     QStringList list = _settings->keys();
340     foreach(QString key, list)
341             returnSettings->setValue(key,_settings->value(key));
342     return returnSettings;
343 */
344     return _settings;
345 }
346
347
348 bool XdxfPlugin::isCached() {
349     if(_settings->value("cached") == "true")
350         return true;
351     return false;
352 }
353
354
355 void XdxfPlugin::setSettings(const Settings *settings) {
356     if(settings) {
357
358         bool isPathChange=false;
359         QString oldPath = _settings->value("path");
360         if(oldPath != settings->value("path")) {
361             if(oldPath!="" && _settings->value("cache_path")!="")
362                 clean();
363             isPathChange=true;
364         }
365
366         foreach(QString key, settings->keys()) {
367            if(key != "generateCache")
368                _settings->setValue(key, settings->value(key));
369         }
370
371         if(isPathChange) {
372             _wordsCount=0;
373             if(oldPath!="")
374                 _settings->setValue("cached","false");
375             if(_settings->value("cached")=="true"
376                     && _settings->value("cache_path")!="") {
377                 db_name = _settings->value("type")
378                         + _settings->value("cache_path");
379                 db = QSqlDatabase::addDatabase("QSQLITE",db_name);
380             }
381         }
382
383         if((_settings->value("cached") == "false" ||
384             _settings->value("cached").isEmpty()) &&
385             settings->value("generateCache") == "true") {
386             clean();
387             makeCache("");
388         }
389
390         else if (settings->value("generateCache") == "false") {
391             _settings->setValue("cached", "false");
392         }
393
394         getDictionaryInfo();
395     }
396     Q_EMIT settingsChanged();
397 }
398
399
400 void XdxfPlugin::getDictionaryInfo() {
401     QFile dictionaryFile(_settings->value("path"));
402     if(!QFile::exists(_settings->value("path"))
403                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
404        Q_EMIT notify(Notify::Warning,
405                QString(tr("XDXF dictionary cannot be read from file")));
406         qDebug()<<"Error: could not open file";
407         return;
408     }
409
410     QXmlStreamReader reader(&dictionaryFile);
411     reader.readNextStartElement();
412     if(reader.name()=="xdxf") {
413       if(reader.attributes().hasAttribute("lang_from"))
414         _langFrom = reader.attributes().value("lang_from").toString();
415       if(reader.attributes().hasAttribute("lang_to"))
416         _langTo = reader.attributes().value("lang_to").toString();
417     }
418     reader.readNextStartElement();
419     if(reader.name()=="full_name")
420         _name=reader.readElementText();
421     reader.readNextStartElement();
422     if(reader.name()=="description")
423         _infoNote=reader.readElementText();
424
425     QString format = "png";
426     QString initialPath = QDir::currentPath() + "/xdxf." + format;
427
428     _infoNote="path=\""+initialPath+"\"> \n" + _name + " [" + _langFrom + "-"
429                 + _langTo + "] ( xdxf )";
430     dictionaryFile.close();
431 }
432
433
434 QIcon* XdxfPlugin::icon() {
435     return &_icon;
436 }
437
438
439 int XdxfPlugin::countWords() {
440     if(_wordsCount>0)
441         return _wordsCount;
442     QFile dictionaryFile(_settings->value("path"));
443     if(!QFile::exists(_settings->value("path"))
444                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
445         Q_EMIT notify(Notify::Warning,
446                 QString(tr("XDXF file cannot be read for %1 dictionary")
447                 .arg(name())));
448         qDebug()<<"Error: could not open file";
449         return -1;
450     }
451
452     dictionaryFile.seek(0);
453
454     long wordsCount = 0;
455
456     QString line;
457     while(!dictionaryFile.atEnd()) {
458         line = dictionaryFile.readLine();
459         if(line.contains("<k>")) {
460             wordsCount++;
461         }
462     }
463     _wordsCount = wordsCount;
464     dictionaryFile.close();
465     return wordsCount;
466 }
467
468
469 bool XdxfPlugin::makeCache(QString) {
470     cachingDialog->setVisible(true);
471     QCoreApplication::processEvents();
472     QFileInfo dictFileN(_settings->value("path"));
473     QString cachePathN;
474     stopped = false;
475
476     /*create cache file name*/
477     int i=0;
478     do {
479         cachePathN = QDir::homePath() + "/.mdictionary/"
480                                       + dictFileN.completeBaseName()+"."
481                                       +QString::number(i) + ".cache";
482         i++;
483     } while(QFile::exists(cachePathN));
484
485     db_name = _settings->value("type") + cachePathN;
486     db = QSqlDatabase::addDatabase("QSQLITE",db_name);
487
488     qDebug()<<QSqlDatabase::connectionNames().size();
489     foreach(QString name,QSqlDatabase::connectionNames())
490         qDebug()<<name;
491     /*checke errors (File open and db open)*/
492     QFile dictionaryFile(dictFileN.filePath());
493     if (!QFile::exists(_settings->value("path"))
494                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
495         Q_EMIT updateCachingProgress(100, 0);
496         Q_EMIT notify(Notify::Warning,
497                 QString(tr("XDXF file cannot be read for %1 dictionary")
498                 .arg(name())));
499         return 0;
500     }
501     QXmlStreamReader reader(&dictionaryFile);
502     db.setDatabaseName(cachePathN);
503     if(!db.open()) {
504         qDebug() << "Database error" << db.lastError().text() << endl;
505         Q_EMIT updateCachingProgress(100, 0);
506         Q_EMIT notify(Notify::Warning, QString(tr("Cache database cannot be "
507                 "opened for %1 dictionary. Searching in XDXF file. "
508                 "You may want to recache.").arg(name())));
509         return false;
510     }
511
512     /*inicial sqlQuery*/
513     QCoreApplication::processEvents();
514     QSqlQuery cur(db);
515     cur.exec("PRAGMA synchronous = 0");
516     cur.exec("drop table dict");
517     QCoreApplication::processEvents();
518     cur.exec("create table dict(word text, normalized text ,translation text)");
519     int counter = 0;
520     cur.exec("BEGIN;");
521
522     QString readKey;
523     bool match = false;
524     QTime timer;
525     timer.start();
526     countWords();
527     int lastProg = -1;
528     _settings->setValue("strip_accents", "true");
529     counter=0;
530
531     /*add all words to db*/
532     while (!reader.atEnd() && !stopped) {
533         QCoreApplication::processEvents();
534         reader.readNext();
535         if(reader.tokenType() == QXmlStreamReader::StartElement) {
536             if(reader.name()=="k"){
537                 readKey = reader.readElementText();
538                 match = true;
539             }
540         }
541         if(match) {
542             QString temp("");
543             while(reader.name()!="ar" && !reader.atEnd()) {
544                 if(reader.name()!="" && reader.name()!="k") {
545                     if(reader.tokenType()==QXmlStreamReader::EndElement)
546                         temp+="</";
547                     if(reader.tokenType()==QXmlStreamReader::StartElement)
548                         temp+="<";
549                     temp+=reader.name().toString();
550                     if(reader.name().toString()=="c"
551                         && reader.tokenType()==QXmlStreamReader::StartElement) {
552                         temp= temp + " c=\""
553                                    + reader.attributes().value("c").toString()
554                                    + "\"";
555                     }
556                     temp+=">";
557                 }
558                 temp+= reader.text().toString().replace("<","&lt;").replace(">"
559                               ,"&gt;");
560                 reader.readNext();
561             }
562             if(temp.at(0)==QChar('\n'))
563                 temp.remove(0,1);
564             temp="<key>" + readKey + "</key>" + "<t>" + temp+ "</t>";
565             match=false;
566             cur.prepare("insert into dict values(?,?,?)");
567             cur.addBindValue(readKey);
568             cur.addBindValue(removeAccents(readKey));
569             cur.addBindValue(temp);
570             cur.exec();
571             counter++;
572             int prog = counter*100/_wordsCount;
573             if(prog % 5 == 0 && lastProg != prog) {
574                 Q_EMIT updateCachingProgress(prog,timer.restart());
575                 lastProg = prog;
576             }
577         }
578     }
579     cur.exec("END;");
580     cur.exec("select count(*) from dict");
581     cachingDialog->setVisible(false);
582
583     /*checke errors (wrong number of added words)*/
584     countWords();
585     if(!cur.next() || countWords() != cur.value(0).toInt()) {
586         Q_EMIT updateCachingProgress(100, timer.restart());
587         Q_EMIT notify(Notify::Warning,
588                 QString(tr("Database caching error, please try againg.")));
589         db.close();
590         return false;
591     }
592
593     _settings->setValue("cache_path", cachePathN);
594     _settings->setValue("cached", "true");
595
596     db.close();
597     return true;
598 }
599
600
601 void XdxfPlugin::clean() {
602     if(QFile::exists(_settings->value("cache_path"))) {
603         QFile(_settings->value("cache_path")).remove();
604         QSqlDatabase::removeDatabase(db_name);
605     }
606 }
607
608
609 Q_EXPORT_PLUGIN2(xdxf, XdxfPlugin)