/*************************************************************************** Copyright 2008 Frederik Gladhorn ***************************************************************************/ /*************************************************************************** * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * * (at your option) any later version. * * * ***************************************************************************/ #include "entryfilter.h" #include "prefs.h" #include #include #include #include #include EntryFilter::EntryFilter(QObject * parent, KEduVocDocument* doc) :QObject(parent) { m_doc = doc; m_dialog = 0; // keep languages consistant between the edit, the filter, and practice switch (Prefs::testType()) { // bilingual mode. case Prefs::EnumTestType::WrittenTest: case Prefs::EnumTestType::MixedLettersTest: case Prefs::EnumTestType::MultipleChoiceTest: // case Prefs::EnumTestType::FlashCardsTest: m_fromTranslation = Prefs::questionLanguage(); m_toTranslation = Prefs::solutionLanguage(); break; // monolingual mode case Prefs::EnumTestType::ArticleTest: case Prefs::EnumTestType::ExampleTest: case Prefs::EnumTestType::ParaphraseTest: case Prefs::EnumTestType::SynonymTest: case Prefs::EnumTestType::AntonymTest: case Prefs::EnumTestType::ComparisonTest: case Prefs::EnumTestType::ConjugationTest: default: m_fromTranslation = m_toTranslation = Prefs::questionLanguage(); break; } expireEntries(); } EntryFilter::~ EntryFilter() { } void EntryFilter::expireEntries() { if ( Prefs::expire() ) { int counter = 0; foreach (KEduVocExpression* entry, m_entries) { int grade = entry->translation(m_toTranslation)->grade(); const QDateTime &date = entry->translation(m_toTranslation)->practiceDate(); const QDateTime &expireDate = QDateTime::currentDateTime().addSecs( -Prefs::expireItem(grade) ); if ( date < expireDate && grade > 0) { // decrease the grade entry->translation(m_toTranslation)->decGrade(); // prevent from endless dropping entry->translation(m_toTranslation)->setPracticeDate( QDateTime::currentDateTime().addSecs( -Prefs::expireItem( grade - 2) ) ); counter++; } } kDebug() << "Expired words dropped their grade: " << counter; } } QList EntryFilter::entries() { // set up the lists/sets of filtered vocabulary m_entries = m_doc->lesson()->entries(KEduVocLesson::Recursive).toSet(); cleanupInvalid(); kDebug() << "Document contains " << m_entries.count() << " valid entries."; if (m_entries.count() == 0) { KMessageBox::error(0, i18n("The vocabulary document contains no entries that can be used for the chosen type of practice.")); return m_entries.toList(); } if (Prefs::testType() == Prefs::EnumTestType::ArticleTest) { if (m_doc->identifier(m_toTranslation).article().isEmpty()) { KMessageBox::error(0, i18n("The vocabulary document contains no articles for the current language. Please add some in the Edit->Grammar menu.")); return QList(); } } lessonEntries(); wordTypeEntries(); blockedEntries(); timesWrongEntries(); timesPracticedEntries(); minMaxGradeEntries(); updateTotal(); if (m_currentSelection.count() == 0) { kDebug() << "Creating practice filter dialog."; m_dialog = new KDialog; m_dialog->setCaption(i18n("Start Practice")); QWidget *widget = new QWidget(m_dialog); ui.setupUi(widget); m_dialog->setMainWidget(widget); m_dialog->setButtons( KDialog::Ok | KDialog::Cancel ); ui.lessonLabel->setText(QString::number(m_entriesLesson.count())); ui.wordTypeLabel->setText(QString::number(m_entriesWordType.count())); ui.blockedLabel->setText(QString::number(m_entriesBlocked.count())); ui.timesWrongLabel->setText(QString::number(m_entriesTimesWrong.count())); ui.timesPracticedLabel->setText(QString::number(m_entriesTimesPracticed.count())); ui.minMaxGradeLabel->setText(QString::number(m_entriesMinMaxGrade.count())); ui.documentTotalLabel->setText(QString::number(m_entries.count())); updateTotal(); ui.lessonCheckBox->setChecked(!m_entriesLesson.count()); ui.wordTypeCheckBox->setChecked(!m_entriesWordType.count()); ui.blockedCheckBox->setChecked(!m_entriesBlocked.count()); ui.timesWrongCheckBox->setChecked(!m_entriesTimesWrong.count()); ui.timesPracticedCheckBox->setChecked(!m_entriesTimesPracticed.count()); ui.minMaxGradeCheckBox->setChecked(!m_entriesMinMaxGrade.count()); connect( m_dialog, SIGNAL(okClicked()), this, SLOT(userSelectionAccepted()) ); connect( m_dialog, SIGNAL(cancelClicked()), this, SLOT(userSelectionCanceled()) ); connect( ui.lessonCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); connect( ui.wordTypeCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); connect( ui.blockedCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); connect( ui.timesWrongCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); connect( ui.timesPracticedCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); connect( ui.minMaxGradeCheckBox, SIGNAL(toggled(bool)), this, SLOT(checkBoxChanged(bool))); updateTotal(); if (!Prefs::wordTypesInPracticeEnabled()) { ui.wordTypeLabel->setVisible(false); ui.wordTypeCheckBox->setVisible(false); } if (m_dialog->exec() == QDialog::Rejected) { delete m_dialog; return QList(); } delete m_dialog; } return m_currentSelection.toList(); } void EntryFilter::checkBoxChanged(bool filter) { updateTotal(); } void EntryFilter::updateTotal() { QSet< KEduVocExpression * > selected = m_entries; if (!m_dialog || !ui.lessonCheckBox->isChecked()) { selected = selected.intersect(m_entriesLesson); } if (!m_dialog || !ui.wordTypeCheckBox->isChecked()) { selected = selected.intersect(m_entriesWordType); } if (!m_dialog || !ui.blockedCheckBox->isChecked()) { selected = selected.intersect(m_entriesBlocked); } if (!m_dialog || !ui.timesWrongCheckBox->isChecked()) { selected = selected.intersect(m_entriesTimesWrong); } if (!m_dialog || !ui.timesPracticedCheckBox->isChecked()) { selected = selected.intersect(m_entriesTimesPracticed); } if (!m_dialog || !ui.minMaxGradeCheckBox->isChecked()) { selected = selected.intersect(m_entriesMinMaxGrade); } if (m_dialog) { ui.totalLabel->setText(QString::number(selected.count())); m_dialog->enableButtonOk(selected.count() > 0); } m_currentSelection = selected; } void EntryFilter::lessonEntries() { /// @todo maybe randomize foreach(KEduVocExpression* entry, m_entries) { if (entry->lesson()->inPractice()) { m_entriesLesson.insert(entry); } } //if ( Prefs::testOrderLesson() ) { } void EntryFilter::wordTypeEntries() { if (Prefs::wordTypesInPracticeEnabled()) { foreach(KEduVocExpression* entry, m_entries) { if (entry->translation(m_toTranslation)->wordType()) { if(entry->translation(m_toTranslation)->wordType()->inPractice()) { m_entriesWordType.insert(entry); } } } } else { m_entriesWordType = m_entries; } } void EntryFilter::blockedEntries() { if (!Prefs::block()) { m_entriesBlocked = m_entries; return; } foreach(KEduVocExpression* entry, m_entries) { int grade = entry->translation(m_toTranslation)->grade(); if (grade == KV_NORM_GRADE || Prefs::blockItem(grade) == 0) { m_entriesBlocked.insert(entry); } else { QDateTime date = entry->translation(m_toTranslation)->practiceDate(); if (date.addSecs(Prefs::blockItem(grade)) < QDateTime::currentDateTime()) { m_entriesBlocked.insert(entry); } } } } void EntryFilter::timesWrongEntries() { foreach(KEduVocExpression* entry, m_entries) { if (entry->translation(m_toTranslation)->badCount() >= Prefs::practiceMinimumWrongCount() && entry->translation(m_toTranslation)->badCount() <= Prefs::practiceMaximumWrongCount()) { m_entriesTimesWrong.insert(entry); } } } void EntryFilter::timesPracticedEntries() { foreach(KEduVocExpression* entry, m_entries) { if (entry->translation(m_toTranslation)->practiceCount() >= Prefs::practiceMinimumTimesAsked() && entry->translation(m_toTranslation)->practiceCount() <= Prefs::practiceMaximumTimesAsked()) { m_entriesTimesPracticed.insert(entry); } } } void EntryFilter::minMaxGradeEntries() { foreach(KEduVocExpression* entry, m_entries) { int grade = entry->translation(m_toTranslation)->grade(); if (grade >= Prefs::practiceMinimumGrade() && grade <= Prefs::practiceMaximumGrade()) { m_entriesMinMaxGrade.insert(entry); } } } /* if (m_testType == Prefs::EnumTestType::ArticleTest) { KMessageBox::information(0, i18n("You selected to practice the genders of nouns, but no appropriate nouns could be found. Use \"Edit Entry\" and select Noun as word type and the gender."), i18n("No valid word type found")); return; } if (m_testType == Prefs::EnumTestType::ComparisonTest) { KMessageBox::information(0, i18n("You selected to practice comparison forms, but no adjectives or adverbs containing comparison forms could be found. Use \"Edit Entry\" and select Adverb or Adjective as word type and enter the comparison forms."), i18n("No valid word type found")); return; } if (m_testType == Prefs::EnumTestType::ConjugationTest) { KMessageBox::information(0, i18n("You selected to practice conjugations, but no vocabulary containing conjugations in the tenses you selected could be found. Use \"Edit Entry\" and select Verb as word type and enter the conjugation forms."), i18n("No valid word type found")); return; } } if ( removeTestEntryList.count() == m_entries.count() ) { if ( KMessageBox::questionYesNo(0, i18n("

The lessons you selected for the practice contain no entries when the threshold settings are respected.

Hint: To configure the thresholds use the \"Threshold Page\" in the \"Configure Practice\" dialog.

Would you like to ignore the threshold setting?

"), i18n("No Entries with Current Threshold Settings") ) == KMessageBox::No ) { return; } */ void EntryFilter::cleanupInvalid() { bool typeTest = Prefs::testType() == Prefs::EnumTestType::ArticleTest || Prefs::testType() == Prefs::EnumTestType::ComparisonTest || Prefs::testType() == Prefs::EnumTestType::ConjugationTest || Prefs::testType() == Prefs::EnumTestType::SynonymTest || Prefs::testType() == Prefs::EnumTestType::AntonymTest || Prefs::testType() == Prefs::EnumTestType::ParaphraseTest || Prefs::testType() == Prefs::EnumTestType::ExampleTest; QSet::iterator i = m_entries.begin(); while (i != m_entries.end()) { // remove empty entries if ((*i)->translation(m_toTranslation)->text().isEmpty() || (*i)->translation(m_fromTranslation)->text().isEmpty()) { i = m_entries.erase(i); } else if (typeTest) { if(!(*i)->translation(m_toTranslation)->wordType()) { i = m_entries.erase(i); } else { switch (Prefs::testType()) { // if we do a grammar test, check if the grammar type is valid case Prefs::EnumTestType::ArticleTest: if (! ((*i)->translation(m_toTranslation)->wordType()->wordType() & KEduVocWordFlag::Noun)) { i = m_entries.erase(i); } else i++; break; case Prefs::EnumTestType::ComparisonTest: if (! ((Prefs::comparisonIncludeAdjective() &&(*i)->translation(m_toTranslation)->wordType()->wordType() == KEduVocWordFlag::Adjective) || (Prefs::comparisonIncludeAdverb() &&(*i)->translation(m_toTranslation)->wordType()->wordType() == KEduVocWordFlag::Adverb))) { i = m_entries.erase(i); } else { if ((*i)->translation(m_toTranslation)->comparative().isEmpty() && (*i)->translation(m_toTranslation)->superlative().isEmpty()) { i = m_entries.erase(i); } else i++; } break; case Prefs::EnumTestType::ConjugationTest: if ( (*i)->translation(m_toTranslation)->wordType()->wordType() != KEduVocWordFlag::Verb || (*i)->translation(m_toTranslation)->conjugations().count() == 0) { i = m_entries.erase(i); } else i++; // conjugation break; case Prefs::EnumTestType::SynonymTest: if ((*i)->translation(m_toTranslation)->synonyms().isEmpty()){ i = m_entries.erase(i); } else i++; break; case Prefs::EnumTestType::AntonymTest: if ((*i)->translation(m_toTranslation)->antonyms().isEmpty()){ i = m_entries.erase(i); } else i++; break; case Prefs::EnumTestType::ParaphraseTest: if ((*i)->translation(m_toTranslation)->paraphrase().isEmpty()){ i = m_entries.erase(i); } else i++; break; case Prefs::EnumTestType::ExampleTest: if ((*i)->translation(m_toTranslation)->example().simplified().isEmpty()){ i = m_entries.erase(i); } else i++; break; } // switch } // type valid } else { // if typeTest i++; } } // for kDebug() << "Invalid items removed. Remaining: " << m_entries.count(); } #include "entryfilter.moc"