/* This file is (c) 2008-2012 Konstantin Isakov * Part of GoldenDict. Licensed under GPLv3 or later, see the LICENSE file */ #include "forvo.hh" #include "wstring_qt.hh" #include #include #include #include #include "audiolink.hh" #include "htmlescape.hh" #include "country.hh" #include "language.hh" #include "langcoder.hh" #include "utf8.hh" #include "gddebug.hh" #include "qt4x5.hh" namespace Forvo { using namespace Dictionary; namespace { class ForvoDictionary: public Dictionary::Class { string name; QString apiKey, languageCode; QNetworkAccessManager & netMgr; public: ForvoDictionary( string const & id, string const & name_, QString const & apiKey_, QString const & languageCode_, QNetworkAccessManager & netMgr_ ): Dictionary::Class( id, vector< string >() ), name( name_ ), apiKey( apiKey_ ), languageCode( languageCode_ ), netMgr( netMgr_ ) { } virtual string getName() throw() { return name; } virtual map< Property, string > getProperties() throw() { return map< Property, string >(); } virtual unsigned long getArticleCount() throw() { return 0; } virtual unsigned long getWordCount() throw() { return 0; } virtual sptr< WordSearchRequest > prefixMatch( wstring const & /*word*/, unsigned long /*maxResults*/ ) THROW_SPEC( std::exception ) { sptr< WordSearchRequestInstant > sr = new WordSearchRequestInstant; sr->setUncertain( true ); return sr; } virtual sptr< DataRequest > getArticle( wstring const &, vector< wstring > const & alts, wstring const &, bool ) THROW_SPEC( std::exception ); protected: virtual void loadIcon() throw(); }; sptr< DataRequest > ForvoDictionary::getArticle( wstring const & word, vector< wstring > const & alts, wstring const &, bool ) THROW_SPEC( std::exception ) { if ( word.size() > 80 ) { // Don't make excessively large queries -- they're fruitless anyway return new DataRequestInstant( false ); } else return new ForvoArticleRequest( word, alts, apiKey, languageCode, getId(), netMgr ); } void ForvoDictionary::loadIcon() throw() { if ( dictionaryIconLoaded ) return; // Experimental code to generate icon -- but the flags clutter the interface too // much and we're better with a single icon. #if 0 if ( languageCode.size() == 2 ) { QString countryCode = Language::countryCodeForId( LangCoder::code2toInt( languageCode.toLatin1().data() ) ); if ( countryCode.size() ) { QImage flag( QString( ":/flags/%1.png" ).arg( countryCode.toLower() ) ); if ( !flag.isNull() ) { QImage img( ":/icons/forvo_icon_base.png" ); { QPainter painter( &img ); painter.drawImage( QPoint( 5, 7 ), flag ); } return QIcon( QPixmap::fromImage( img ) ); } } } #endif dictionaryIcon = dictionaryNativeIcon = QIcon( ":/icons/forvo.png" ); dictionaryIconLoaded = true; } } void ForvoArticleRequest::cancel() { finish(); } ForvoArticleRequest::ForvoArticleRequest( wstring const & str, vector< wstring > const & alts, QString const & apiKey_, QString const & languageCode_, string const & dictionaryId_, QNetworkAccessManager & mgr ): apiKey( apiKey_ ), languageCode( languageCode_ ), dictionaryId( dictionaryId_ ) { connect( &mgr, SIGNAL( finished( QNetworkReply * ) ), this, SLOT( requestFinished( QNetworkReply * ) ), Qt::QueuedConnection ); addQuery( mgr, str ); for( unsigned x = 0; x < alts.size(); ++x ) addQuery( mgr, alts[ x ] ); } void ForvoArticleRequest::addQuery( QNetworkAccessManager & mgr, wstring const & str ) { gdDebug( "Forvo: requesting article %s\n", gd::toQString( str ).toUtf8().data() ); QString key; if ( apiKey.simplified().isEmpty() ) { // Use the default api key. That's the key I have just registered myself. // It has a limit of 1000 requests a day, and may also get banned in the // future. Can't do much about it. Get your own key, it is simple. key = "5efa5d045a16d10ad9c4705bd5d8e56a"; } else key = apiKey; QUrl reqUrl = QUrl::fromEncoded( QString( "https://apifree.forvo.com" "/key/" + key + "/action/word-pronunciations" "/format/xml" "/word/" + QLatin1String( QUrl::toPercentEncoding( gd::toQString( str ) ) ) + "/language/" + languageCode + "/order/rate-desc" ).toUtf8() ); // DPRINTF( "req: %s\n", reqUrl.toEncoded().data() ); sptr< QNetworkReply > netReply = mgr.get( QNetworkRequest( reqUrl ) ); netReplies.push_back( NetReply( netReply, Utf8::encode( str ) ) ); } void ForvoArticleRequest::requestFinished( QNetworkReply * r ) { GD_DPRINTF( "Finished.\n" ); if ( isFinished() ) // Was cancelled return; // Find this reply bool found = false; for( NetReplies::iterator i = netReplies.begin(); i != netReplies.end(); ++i ) { if ( i->reply.get() == r ) { i->finished = true; // Mark as finished found = true; break; } } if ( !found ) { // Well, that's not our reply, don't do anything return; } bool updated = false; for( ; netReplies.size() && netReplies.front().finished; netReplies.pop_front() ) { sptr< QNetworkReply > netReply = netReplies.front().reply; if ( netReply->error() == QNetworkReply::NoError ) { QDomDocument dd; QString errorStr; int errorLine, errorColumn; if ( !dd.setContent( netReply.get(), false, &errorStr, &errorLine, &errorColumn ) ) { setErrorString( QString( tr( "XML parse error: %1 at %2,%3" ). arg( errorStr ).arg( errorLine ).arg( errorColumn ) ) ); } else { // DPRINTF( "%s\n", dd.toByteArray().data() ); QDomNode items = dd.namedItem( "items" ); if ( !items.isNull() ) { QDomNodeList nl = items.toElement().elementsByTagName( "item" ); if ( nl.count() ) { string articleBody; articleBody += "
"; articleBody += Html::escape( netReplies.front().word ); articleBody += "
"; articleBody += ""; for( Qt4x5::Dom::size_type x = 0; x < nl.length(); ++x ) { QDomElement item = nl.item( x ).toElement(); QDomNode mp3 = item.namedItem( "pathmp3" ); if ( !mp3.isNull() ) { articleBody += ""; QUrl url( mp3.toElement().text() ); string ref = string( "\"" ) + url.toEncoded().data() + "\""; articleBody += addAudioLink( ref, dictionaryId ).c_str(); bool isMale = ( item.namedItem( "sex" ).toElement().text().toLower() != "f" ); QString user = item.namedItem( "username" ).toElement().text(); QString country = item.namedItem( "country" ).toElement().text(); string userProfile = string( "http://www.forvo.com/user/" ) + QUrl::toPercentEncoding( user ).data() + "/"; int totalVotes = item.namedItem( "num_votes" ).toElement().text().toInt(); int positiveVotes = item.namedItem( "num_positive_votes" ).toElement().text().toInt(); int negativeVotes = totalVotes - positiveVotes; string votes; if ( positiveVotes || negativeVotes ) { votes += " "; if ( positiveVotes ) { votes += "+"; votes += QByteArray::number( positiveVotes ).data(); votes += ""; } if ( negativeVotes ) { if ( positiveVotes ) votes += " "; votes += "-"; votes += QByteArray::number( negativeVotes ).data(); votes += ""; } } string addTime = tr( "Added %1" ).arg( item.namedItem( "addtime" ).toElement().text() ).toUtf8().data(); articleBody += ""; articleBody += string( ""; articleBody += ""; } } articleBody += "
\"Play\"/" ) + tr( "by" ).toUtf8().data() + " " + Html::escape( user.toUtf8().data() ) + " (" + ( isMale ? tr( "Male" ) : tr( "Female" ) ).toUtf8().data() + " " + tr( "from" ).toUtf8().data() + " " + " " + Html::escape( country.toUtf8().data() ) + ")" + votes + "
"; Mutex::Lock _( dataMutex ); size_t prevSize = data.size(); data.resize( prevSize + articleBody.size() ); memcpy( &data.front() + prevSize, articleBody.data(), articleBody.size() ); hasAnyData = true; updated = true; } } QDomNode errors = dd.namedItem( "errors" ); if ( !errors.isNull() ) { QString text( errors.namedItem( "error" ).toElement().text() ); if ( text == "Limit/day reached." && apiKey.simplified().isEmpty() ) { // Give a hint that the user should apply for his own key. text += "\n" + tr( "Go to Edit|Dictionaries|Sources|Forvo and apply for our own API key to make this error disappear." ); } setErrorString( text ); } } GD_DPRINTF( "done.\n" ); } else setErrorString( netReply->errorString() ); } if ( netReplies.empty() ) finish(); else if ( updated ) update(); } vector< sptr< Dictionary::Class > > makeDictionaries( Dictionary::Initializing &, Config::Forvo const & forvo, QNetworkAccessManager & mgr ) THROW_SPEC( std::exception ) { vector< sptr< Dictionary::Class > > result; if ( forvo.enable ) { QStringList codes = forvo.languageCodes.split( ',', QString::SkipEmptyParts ); QSet< QString > usedCodes; for( int x = 0; x < codes.size(); ++x ) { QString code = codes[ x ].simplified(); if ( code.size() && !usedCodes.contains( code ) ) { // Generate id QCryptographicHash hash( QCryptographicHash::Md5 ); hash.addData( "Forvo source version 1.0" ); hash.addData( code.toUtf8() ); QString displayedCode( code.toLower() ); if ( displayedCode.size() ) displayedCode[ 0 ] = displayedCode[ 0 ].toUpper(); result.push_back( new ForvoDictionary( hash.result().toHex().data(), QString( "Forvo (%1)" ).arg( displayedCode ).toUtf8().data(), forvo.apiKey, code, mgr ) ); usedCodes.insert( code ); } } } return result; } }