vcs.maemo.org Git - mdictionary/blob - src/plugins/xdxf/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 "../../include/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();
 313     if(settings && plugin->setSettings(settings)) {
 314         return plugin;
 315     }
 316     else {
 317         delete plugin;
 318         return 0;
 319     }
 320 }
 321
 322
 323 bool XdxfPlugin::isAvailable() const {
 324     return true;
 325 }
 326
 327
 328 void XdxfPlugin::setHash(uint _hash) {
 329     this->_hash=_hash;
 330 }
 331
 332
 333 uint XdxfPlugin::hash() const {
 334    return _hash;
 335 }
 336
 337
 338 Settings* XdxfPlugin::settings() {
 339 /*
 340     Settings *returnSettings=new Settings;
 341     QStringList list = _settings->keys();
 342     foreach(QString key, list)
 343             returnSettings->setValue(key,_settings->value(key));
 344     return returnSettings;
 345 */
 346     return _settings;
 347 }
 348
 349
 350 bool XdxfPlugin::isCached() {
 351     if(_settings->value("cached") == "true")
 352         return true;
 353     return false;
 354 }
 355
 356
 357 bool XdxfPlugin::setSettings(const Settings *settings) {
 358     if(settings) {
 359         bool isPathChange=false;
 360         QString oldPath = _settings->value("path");
 361         Settings *oldSettings =  new Settings ;
 362
 363         if(oldPath != settings->value("path")) {
 364             if(oldPath!="" && _settings->value("cache_path")!="")
 365                 clean();
 366             isPathChange=true;
 367         }
 368
 369         foreach(QString key, _settings->keys())
 370             oldSettings->setValue(key, _settings->value(key));
 371
 372         foreach(QString key, settings->keys()) {
 373            if(key != "generateCache")
 374                _settings->setValue(key, settings->value(key));
 375         }
 376
 377         if(!getDictionaryInfo()) {
 378             Q_EMIT notify(Notify::Warning,
 379                 QString(tr("XDXF file is in wrong format")));
 380             qDebug()<<"Error: xdxf file is in wrong format";
 381             delete _settings;
 382             _settings=oldSettings;
 383             return false;
 384         }
 385
 386         if(isPathChange) {
 387             _wordsCount=0;
 388             if(oldPath!="")
 389                 _settings->setValue("cached","false");
 390             if(_settings->value("cached")=="true"
 391                     && _settings->value("cache_path")!="") {
 392                 db_name = _settings->value("type")
 393                         + _settings->value("cache_path");
 394                 db = QSqlDatabase::addDatabase("QSQLITE",db_name);
 395             }
 396         }
 397
 398         if((_settings->value("cached") == "false" ||
 399             _settings->value("cached").isEmpty()) &&
 400             settings->value("generateCache") == "true") {
 401             clean();
 402             makeCache("");
 403         }
 404
 405         else if (settings->value("generateCache") == "false") {
 406             _settings->setValue("cached", "false");
 407         }
 408     }
 409     else
 410         return false;
 411     Q_EMIT settingsChanged();
 412     return true;
 413 }
 414
 415
 416 bool XdxfPlugin::getDictionaryInfo() {
 417     QFile dictionaryFile(_settings->value("path"));
 418     if(!QFile::exists(_settings->value("path"))
 419                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
 420        Q_EMIT notify(Notify::Warning,
 421                QString(tr("XDXF dictionary cannot be read from file")));
 422         qDebug()<<"Error: could not open file";
 423         return false;
 424     }
 425
 426     bool okFormat=false;
 427     QXmlStreamReader reader(&dictionaryFile);
 428     reader.readNextStartElement();
 429     if(reader.name()=="xdxf") {
 430         okFormat=true;
 431         if(reader.attributes().hasAttribute("lang_from"))
 432             _langFrom = reader.attributes().value("lang_from").toString();
 433         if(reader.attributes().hasAttribute("lang_to"))
 434             _langTo = reader.attributes().value("lang_to").toString();
 435     }
 436     reader.readNextStartElement();
 437     if(reader.name()=="full_name")
 438         _name=reader.readElementText();
 439     reader.readNextStartElement();
 440     if(reader.name()=="description")
 441         _infoNote=reader.readElementText();
 442
 443     QString initialPath = "/usr/share/mdictionary/xdxf.png";
 444
 445     _infoNote=" path=\""+initialPath+"\"> \n" + _name + " [" + _langFrom + "-"
 446                 + _langTo + "]";
 447     dictionaryFile.close();
 448     if(okFormat)
 449         return true;
 450     return false;
 451 }
 452
 453
 454 QIcon* XdxfPlugin::icon() {
 455     return &_icon;
 456 }
 457
 458
 459 int XdxfPlugin::countWords() {
 460     if(_wordsCount>0)
 461         return _wordsCount;
 462     QFile dictionaryFile(_settings->value("path"));
 463     if(!QFile::exists(_settings->value("path"))
 464                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
 465         Q_EMIT notify(Notify::Warning,
 466                 QString(tr("XDXF file cannot be read for %1 dictionary")
 467                 .arg(name())));
 468         qDebug()<<"Error: could not open file";
 469         return -1;
 470     }
 471
 472     dictionaryFile.seek(0);
 473
 474     long wordsCount = 0;
 475
 476     QString line;
 477     while(!dictionaryFile.atEnd()) {
 478         line = dictionaryFile.readLine();
 479         if(line.contains("<k>")) {
 480             wordsCount++;
 481         }
 482     }
 483     _wordsCount = wordsCount;
 484     dictionaryFile.close();
 485     return wordsCount;
 486 }
 487
 488
 489 bool XdxfPlugin::makeCache(QString) {
 490     cachingDialog->setVisible(true);
 491     QCoreApplication::processEvents();
 492     QFileInfo dictFileN(_settings->value("path"));
 493     QString cachePathN;
 494     stopped = false;
 495
 496     /*create cache file name*/
 497     int i=0;
 498     do {
 499         cachePathN = QDir::homePath() + "/.mdictionary/"
 500                                       + dictFileN.completeBaseName()+"."
 501                                       +QString::number(i) + ".cache";
 502         i++;
 503     } while(QFile::exists(cachePathN));
 504
 505     db_name = _settings->value("type") + cachePathN;
 506     db = QSqlDatabase::addDatabase("QSQLITE",db_name);
 507
 508     /*checke errors (File open and db open)*/
 509     QFile dictionaryFile(dictFileN.filePath());
 510     if (!QFile::exists(_settings->value("path"))
 511                 || !dictionaryFile.open(QFile::ReadOnly | QFile::Text)) {
 512         Q_EMIT updateCachingProgress(100, 0);
 513         Q_EMIT notify(Notify::Warning,
 514                 QString(tr("XDXF file cannot be read for %1 dictionary")
 515                 .arg(name())));
 516         return 0;
 517     }
 518     QXmlStreamReader reader(&dictionaryFile);
 519     db.setDatabaseName(cachePathN);
 520     if(!db.open()) {
 521         qDebug() << "Database error" << db.lastError().text() << endl;
 522         Q_EMIT updateCachingProgress(100, 0);
 523         Q_EMIT notify(Notify::Warning, QString(tr("Cache database cannot be "
 524                 "opened for %1 dictionary. Searching in XDXF file. "
 525                 "You may want to recache.").arg(name())));
 526         return false;
 527     }
 528
 529     /*inicial sqlQuery*/
 530     QCoreApplication::processEvents();
 531     QSqlQuery cur(db);
 532     cur.exec("PRAGMA synchronous = 0");
 533     cur.exec("drop table dict");
 534     QCoreApplication::processEvents();
 535     cur.exec("create table dict(word text, normalized text ,translation text)");
 536     int counter = 0;
 537     cur.exec("BEGIN;");
 538
 539     QString readKey;
 540     bool match = false;
 541     QTime timer;
 542     timer.start();
 543     countWords();
 544     int lastProg = -1;
 545     _settings->setValue("strip_accents", "true");
 546     counter=0;
 547
 548     /*add all words to db*/
 549     while (!reader.atEnd() && !stopped) {
 550         QCoreApplication::processEvents();
 551         reader.readNext();
 552         if(reader.tokenType() == QXmlStreamReader::StartElement) {
 553             if(reader.name()=="k"){
 554                 readKey = reader.readElementText();
 555                 match = true;
 556             }
 557         }
 558         if(match) {
 559             QString temp("");
 560             while(reader.name()!="ar" && !reader.atEnd()) {
 561                 if(reader.name()!="" && reader.name()!="k") {
 562                     if(reader.tokenType()==QXmlStreamReader::EndElement)
 563                         temp+="</";
 564                     if(reader.tokenType()==QXmlStreamReader::StartElement)
 565                         temp+="<";
 566                     temp+=reader.name().toString();
 567                     if(reader.name().toString()=="c"
 568                         && reader.tokenType()==QXmlStreamReader::StartElement) {
 569                         temp= temp + " c=\""
 570                                    + reader.attributes().value("c").toString()
 571                                    + "\"";
 572                     }
 573                     temp+=">";
 574                 }
 575                 temp+= reader.text().toString().replace("<","&lt;").replace(">"
 576                               ,"&gt;");
 577                 reader.readNext();
 578             }
 579             if(temp.at(0)==QChar('\n'))
 580                 temp.remove(0,1);
 581             temp="<key>" + readKey + "</key>" + "<t>" + temp+ "</t>";
 582             match=false;
 583             cur.prepare("insert into dict values(?,?,?)");
 584             cur.addBindValue(readKey);
 585             cur.addBindValue(removeAccents(readKey));
 586             cur.addBindValue(temp);
 587             cur.exec();
 588             counter++;
 589             int prog = counter*100/_wordsCount;
 590             if(prog % 5 == 0 && lastProg != prog) {
 591                 Q_EMIT updateCachingProgress(prog,timer.restart());
 592                 lastProg = prog;
 593             }
 594         }
 595     }
 596     cur.exec("END;");
 597     cur.exec("select count(*) from dict");
 598     cachingDialog->setVisible(false);
 599
 600     /*checke errors (wrong number of added words)*/
 601     countWords();
 602     if(!cur.next() || countWords() != cur.value(0).toInt()) {
 603         Q_EMIT updateCachingProgress(100, timer.restart());
 604         Q_EMIT notify(Notify::Warning,
 605                 QString(tr("Database caching error, please try againg.")));
 606         db.close();
 607         return false;
 608     }
 609
 610     _settings->setValue("cache_path", cachePathN);
 611     _settings->setValue("cached", "true");
 612
 613     db.close();
 614     return true;
 615 }
 616
 617
 618 void XdxfPlugin::clean() {
 619     if(QFile::exists(_settings->value("cache_path"))) {
 620         QFile(_settings->value("cache_path")).remove();
 621         QSqlDatabase::removeDatabase(db_name);
 622     }
 623 }
 624
 625
 626 Q_EXPORT_PLUGIN2(xdxf, XdxfPlugin)