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