- Search plugin parses opensearch.xml files and adds them to combobox
[qtrapids] / src / plugins / searchplugin / SearchPlugin.cpp
index f4ded6d..add01e0 100644 (file)
@@ -1,3 +1,23 @@
+/***************************************************************************
+ *   Copyright (C) 2009 by Lassi Väätämöinen   *
+ *   lassi.vaatamoinen@ixonos.com   *
+ *                                                                         *
+ *   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.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
 #include <QDebug>
 #include <QtCore/qplugin.h>
 #include <QVBoxLayout>
 #include <QLineEdit>
 #include <QPushButton>
 #include <QUrl>
+#include <QDir>
+#include <QFileInfo>
 #include <QWebView>
-
+#include <QWebPage>
+#include <QDomDocument>
 
 #include "SearchPlugin.h"
+#include "DownloadManager.h"
 
 namespace qtrapids
 {
-SearchPlugin::SearchPlugin() :
-        comboBox_(NULL), searchLine_(NULL), searchButton_(NULL), host_(NULL)
-{
-    // TODO: Parse engine descriptions.
-    // -Add engines to model
-    // -Show model in comboBox
-
-}
-
-void SearchPlugin::initialize(PluginHostInterface* host)
-{
-    host_ = host;
-
-    if (host_ != NULL)
-    {
-
-        QWidget *pluginWidget = new QWidget;
-        QVBoxLayout *vbox = new QVBoxLayout;
-        QHBoxLayout *hbox = new QHBoxLayout;
-        comboBox_ = new QComboBox;
-        searchLine_ = new QLineEdit;
-        searchButton_ = new QPushButton("Search");
-
-        hbox->addWidget(searchLine_);
-        hbox->addWidget(searchButton_);
-        vbox->addWidget(comboBox_);
-        vbox->addLayout(hbox);
-        pluginWidget->setLayout(vbox);
-
-        connect(searchButton_, SIGNAL(clicked()), this, SLOT(on_searchButton_clicked()));
-        //connect(this, SIGNAL(searchResult(QWidget*)), this, SLOT(on_searchResult(QWidget*)));
-
-        host_->setGui(pluginWidget);
-    }
-}
-
-QWidget* SearchPlugin::getGui()
-{
-    return NULL;
-}
-
-void SearchPlugin::on_searchButton_clicked()
-{
-    QUrl searchUrl(QString("http://www.google.fi/search?q="
-                           + searchLine_->text()));
-    qDebug() << searchUrl;
-    QWebView *result = new QWebView;
-    result->load(searchUrl);
-
-    on_searchResult((QWidget*)result);
-}
-
-void SearchPlugin::on_searchResult(QWidget* resultWidget)
-{
-    qDebug() << "on_searchResult()";
-    if (host_)
-    {
-        host_->addPluginWidget(resultWidget);
-    }
-}
+       const QString ENGINES_DIR = "engines";
+       const QString DESCRIPTION_FILENAME = "opensearch.xml";
+       const QString SEARCH_TERMS_STRING = "{searchTerms}";
+       
+       
+       SearchPlugin::SearchPlugin() : 
+               comboBox_(NULL), searchLine_(NULL),
+               searchButton_(NULL), result_(NULL), 
+               dlManager_(NULL), host_(NULL)
+       {
+               // TODO: Parse search engine XML(?) descriptions.
+               // -Add search engines to model
+               // -Show model in comboBox
+               // Add back/forward/refresh -buttons to widget to allow some browsing
+       
+       }
+       
+       void SearchPlugin::initialize(PluginHostInterface* host, Info info)
+       {
+               host_ = host;
+               
+               if (host_ != NULL) {
+               
+                       // Build up the plugin widget:
+                       QWidget *pluginWidget = new QWidget;
+                       QVBoxLayout *vbox = new QVBoxLayout;
+                       QHBoxLayout *hbox = new QHBoxLayout;
+                       comboBox_ = new QComboBox;
+                       searchLine_ = new QLineEdit;
+                       searchButton_ = new QPushButton("Search");
+                       
+                       hbox->addWidget(searchLine_);
+                       hbox->addWidget(searchButton_);
+                       vbox->addWidget(comboBox_);
+                       vbox->addLayout(hbox);
+                       pluginWidget->setLayout(vbox);
+       
+                       connect(searchButton_, SIGNAL(clicked()), this, SLOT(on_searchButton_clicked()));
+                       //connect(this, SIGNAL(searchResult(QWidget*)), this, SLOT(on_searchResult(QWidget*)));
+                       qDebug() << info.directory;
+                       QDir dir(info.directory);
+                       if (dir.cd(ENGINES_DIR)) {
+                               ParseSearchEngineDescriptions(dir);
+                       }
+                       
+                       host_->setGui(pluginWidget, qtrapids::PluginHostInterface::BASE_WIDGET);
+               }
+       }
+       
+       QWidget* SearchPlugin::getGui()
+       {
+               return NULL;
+       }
+
+
+       void SearchPlugin::on_searchButton_clicked()
+       {
+               
+               int i = comboBox_->currentIndex();
+               QString tmp = engineTemplates_.at(i);
+               i = tmp.indexOf(SEARCH_TERMS_STRING);
+               tmp.replace(i, SEARCH_TERMS_STRING.length(), searchLine_->text());
+               QUrl searchUrl(tmp);
+               qDebug() << searchUrl;
+               result_ = new QWebView;
+               
+               // Get underlying QWebPage and change link delegation, so we can meddle with links in on_linkClicked().
+               QWebPage *resultPage = result_->page();
+               resultPage->setLinkDelegationPolicy(QWebPage::DelegateExternalLinks);
+               
+               connect(resultPage, SIGNAL(linkClicked(const QUrl&)), this, SLOT(on_linkClicked(const QUrl&)));
+               connect(result_, SIGNAL(loadFinished(bool)), this, SLOT(on_loadFinished(bool)));
+       
+               result_->load(searchUrl);
+               
+               on_searchResult((QWidget*)result_);
+       }
+       
+       
+       void SearchPlugin::on_loadFinished(bool ok)
+       {
+#ifdef QTRAPIDS_DEBUG
+               if (ok) {
+                       qDebug() << "on_loadFinished(): success";
+               }
+#endif
+       }
+       
+       
+       void SearchPlugin::on_searchResult(QWidget* resultWidget)
+       {
+#ifdef QTRAPIDS_DEBUG
+               qDebug() << "on_searchResult()";
+#endif
+               if (host_) {
+                       host_->addPluginWidget(resultWidget, qtrapids::PluginHostInterface::TAB_PAGE);
+               }
+       }
+
+       void SearchPlugin::on_linkClicked(const QUrl& url)
+       {
+               // Get the path part of URL (the part after the host part) 
+               QString path = url.path();
+               QFileInfo fInfo(path);
+               
+               // Check path suffix. If it is .torrent, we should download:
+               /// @todo We should actually check for MIME-type application/x-bittorrent in HTTP response, 
+               /// instead of relying on file suffix.
+               /// e.g. link 
+               ///http://www.bitenova.org/download.php?id=c84375141231eef49fc6c55e6347ba4f4a623a05&name=Nero_Linux_3.5.1.0__(Debian)_deutsch
+               /// will not work.
+               /// @todo Also, after downloading, the torrent bencoding validity should be checked at plugin host..
+               if (fInfo.suffix() == "torrent") {
+#ifdef QTRAPIDS_DEBUG
+                       qDebug() << "IS TORRENT";
+#endif
+                       QString filename = fInfo.fileName();
+                       
+                       // Destroy ongoing download, if any.
+                       if (dlManager_) {
+                               delete dlManager_;
+                               dlManager_ = NULL;
+                       }
+                       
+                       // Start downloading Torrent file.
+                       dlManager_ = new DownloadManager(url, "/tmp/" + filename);
+                       connect(dlManager_, SIGNAL(finished(QString)), this, SLOT(on_downloadFinished(QString)));
+                       dlManager_->start();
+                       
+               } else {
+                       // If was not .torrent -file, check URL validity and load the page as usual.
+                       if (url.isValid()) {
+                               result_->load(url);
+                       }
+               }
+       }
+       
+       void SearchPlugin::on_downloadFinished(QString filepath)
+       {
+#ifdef QTRAPIDS_DEBUG
+               qDebug() << "TORRENT DOWNLOADED: " << filepath;
+#endif
+               delete dlManager_;
+               dlManager_ = NULL;
+               host_->eventRequest(QVariant(filepath), qtrapids::PluginHostInterface::OPEN_FILE);
+       }
+
+
+       void SearchPlugin::ParseSearchEngineDescriptions(const QDir& dir)
+       {
+               foreach (QString dirName, dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)) {
+               
+                               QFile file(dir.path() + "/" + dirName + "/" + DESCRIPTION_FILENAME);
+                               
+                               if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
+                                       qWarning() << "Unable to open " << DESCRIPTION_FILENAME << " for reading in " << dir.path();
+                                       continue;
+                               }
+                               
+                               // Parse the XML file to DOM document.
+                               QDomDocument document;
+                               
+                               // Second parameter: nameSpaceProcessing = false
+                               if (!document.setContent(&file, false)) {
+                                       qWarning() << "Unable to parse " << DESCRIPTION_FILENAME << " in " << dirName;
+                               } else {
+                                       QDomNodeList urlElements = document.elementsByTagName("Url");
+                                       QDomNodeList shortNameElements = document.elementsByTagName("ShortName");
+                                       
+                                       QDomNode n = urlElements.item(0);
+                                       QDomNode m;
+                                       QDomNamedNodeMap attribMap;
+                                       if (n.hasAttributes()) {
+                                               attribMap = n.attributes();
+                                               m = attribMap.namedItem("template");
+                                               engineTemplates_.push_back(m.nodeValue());
+                                       }
+                                       
+                                       n = shortNameElements.item(0);
+                                       if (n.hasChildNodes()) {
+                                               m = n.firstChild();
+                                               comboBox_->addItem(m.nodeValue());
+                                       }
+                               }
+                       }
+                       
+                       
+                       /// @todo save parsed xml elements <Shortname> and <Url template="<foo>"> to a model which is displayed in combobox.
+               }
+               
+                                               /*
+               QDomElement docElem = document.documentElement();
+               QDomNode n = docElem.firstChild();
+               while(!n.isNull()) {
+                       QDomElement e = n.toElement(); // try to convert the node to an element.
+                       if(!e.isNull()) {
+                               qDebug() << qPrintable(e.tagName()); // the node really is an element.
+                       }
+                       n = n.nextSibling();
+               }
+               */
 
 } // namespace qtrapids