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