Merge lp:~osomon/webbrowser-app/opensearch into lp:webbrowser-app

[Olivier Tilloy]

Add support for custom search engines defined by the OpenSearch description document format
(http://www.opensearch.org/Specifications/OpenSearch/1.1).

Instructions for testing:

To change the default search engine (google), edit the following file:

    $HOME/.config/webbrowser-app/settings.conf

and add the following line: "searchengine = {value}" where {value} is the name of the search engine that you want to use, e.g. "duckduckgo".

Then ensure that the following directory exists (create it if not):

    $HOME/.local/share/webbrowser-app/searchengines/

and create under it a file called "{value}.xml" (e.g. "duckduckgo.xml"). This file is expected to follow the OpenSearch description document format (see documentation at http://www.opensearch.org/Specifications/OpenSearch/1.1), here is an example:

 <?xml version="1.0" encoding="UTF-8"?>
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>Duck Duck Go</ShortName>
  <Description>Use Duck Duck Go to search the Web</Description>
  <Url type="text/html" template="https://duckduckgo.com/?q={searchTerms}&amp;t=canonical" />
 </OpenSearchDescription>

[lp:~osomon/webbrowser-app/opensearch]

589. By Olivier Tilloy on 2014-06-30

Keep {searchTerms} as a placeholder token.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:589
http://jenkins.qa.ubuntu.com/job/webbrowser-app-ci/904/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1354
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/1183
    SUCCESS: http://jenkins.qa.ubuntu.com/job/webbrowser-app-utopic-amd64-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/webbrowser-app-utopic-armhf-ci/103
        deb: http://jenkins.qa.ubuntu.com/job/webbrowser-app-utopic-armhf-ci/103/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/webbrowser-app-utopic-i386-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1663
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2279
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2279/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/9032
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic/976
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/1326
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/1326/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/webbrowser-app-ci/904/rebuild

review: Approve (continuous-integration)

[Adnane Belmadiaf (daker)]

Tested and it works.

review: Approve

=== modified file 'README'
--- README	2014-05-06 12:11:27 +0000
+++ README	2014-06-30 11:01:41 +0000
@@ -67,3 +67,22 @@
 This will generate a coverage report in XML format (coverage.xml) and an
 interactive human-readable report in HTML format (coveragereport/index.html).
 
+
+= Settings =
+
+webbrowser-app supports a limited set of custom settings, currently not exposed
+in the UI. The settings are persisted on disk in the following INI-like file:
+
+    $HOME/.config/webbrowser-app/settings.conf
+
+The following keys are supported:
+
+ - 'homepage': a URL that the browser will open when launched if no URL is
+   specified on the command line
+
+ - 'searchengine': a custom search engine specification, looked up in
+   $HOME/.local/share/webbrowser-app/searchengines/{value}.xml and following
+   the OpenSearch document description format
+   (http://www.opensearch.org/Specifications/OpenSearch/1.1)
+
+If any of those keys are not specified, the default hardcoded value is used.

=== modified file 'src/app/AddressBar.qml'
--- src/app/AddressBar.qml	2014-06-20 15:52:26 +0000
+++ src/app/AddressBar.qml	2014-06-30 11:01:41 +0000
@@ -30,6 +30,7 @@
     signal requestReload()
     signal requestStop()
     signal pressAndHold()
+    property string searchUrl
 
     height: textField.height
 
@@ -164,9 +165,8 @@
     }
 
     function buildSearchUrl(query) {
-        var searchUrl = "https://google.com/search?client=ubuntu&q=%1&ie=utf-8&oe=utf-8"
         var terms = query.split(/\s/).map(escapeHtmlEntities)
-        return searchUrl.arg(terms.join("+"))
+        return addressbar.searchUrl.replace("{searchTerms}", terms.join("+"))
     }
 
     function validate() {

=== modified file 'src/app/Chrome.qml'
--- src/app/Chrome.qml	2014-06-25 16:33:12 +0000
+++ src/app/Chrome.qml	2014-06-30 11:01:41 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013-2014 Canonical Ltd.
  *
  * This file is part of webbrowser-app.
  *
@@ -27,6 +27,7 @@
     property alias url: addressBar.actualUrl
     signal urlValidated(url url)
     property alias addressBar: addressBar
+    property alias searchUrl: addressBar.searchUrl
     property string title
     property alias loading: addressBar.loading
     property alias loadProgress: progressBar.value

=== modified file 'src/app/PanelLoader.qml'
--- src/app/PanelLoader.qml	2014-06-23 10:33:44 +0000
+++ src/app/PanelLoader.qml	2014-06-30 11:01:41 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013-2014 Canonical Ltd.
  *
  * This file is part of webbrowser-app.
  *
@@ -33,9 +33,22 @@
     property bool activityButtonVisible: true
     property bool addressBarVisible: true
 
+    property string searchUrl
+    onSearchUrlChanged: internal.setSearchUrl()
+    onChromeChanged: internal.setSearchUrl()
+
     signal urlValidated
     signal toggleActivityViewClicked
 
+    QtObject {
+        id: internal
+        function setSearchUrl() {
+            if (chromePanel.chrome !== null) {
+                chromePanel.chrome.searchUrl = chromePanel.searchUrl
+            }
+        }
+    }
+
     function open() {
         if (panel) {
             panel.open()

=== modified file 'src/app/config.h.in'
--- src/app/config.h.in	2013-11-14 16:05:18 +0000
+++ src/app/config.h.in	2014-06-30 11:01:41 +0000
@@ -27,6 +27,11 @@
 #define DEFAULT_HOMEPAGE "http://start.ubuntu.com"
 #define REMOTE_INSPECTOR_PORT 9221
 
+#define DEFAULT_SEARCH_ENGINE "google"
+#define DEFAULT_SEARCH_NAME "Google Search"
+#define DEFAULT_SEARCH_DESC "Use google.com to search the Web"
+#define DEFAULT_SEARCH_TEMPLATE "https://google.com/search?client=ubuntu&q={searchTerms}&ie=utf-8&oe=utf-8"
+
 inline bool isRunningInstalled()
 {
     static bool installed = (QCoreApplication::applicationDirPath() == QDir("@CMAKE_INSTALL_FULL_BINDIR@").canonicalPath());

=== modified file 'src/app/webbrowser/Browser.qml'
--- src/app/webbrowser/Browser.qml	2014-06-20 15:52:26 +0000
+++ src/app/webbrowser/Browser.qml	2014-06-30 11:01:41 +0000
@@ -28,6 +28,8 @@
     property alias currentIndex: tabsModel.currentIndex
     currentWebview: tabsModel.currentWebview
 
+    property QtObject searchEngine
+
     actions: [
         Actions.GoTo {
             onTriggered: currentWebview.url = value
@@ -154,6 +156,7 @@
 
         currentWebview: browser.currentWebview
         chromeless: browser.chromeless
+        searchUrl: browser.searchEngine ? browser.searchEngine.template : ""
 
         anchors {
             left: parent.left

=== modified file 'src/app/webbrowser/CMakeLists.txt'
--- src/app/webbrowser/CMakeLists.txt	2014-04-02 13:58:42 +0000
+++ src/app/webbrowser/CMakeLists.txt	2014-06-30 11:01:41 +0000
@@ -24,6 +24,7 @@
 qt5_use_modules(${WEBBROWSER_APP_MODELS} Core Sql)
 
 set(WEBBROWSER_APP_SRC
+    searchengine.cpp
     settings.cpp
     webbrowser-app.cpp
 )

=== added file 'src/app/webbrowser/searchengine.cpp'
--- src/app/webbrowser/searchengine.cpp	1970-01-01 00:00:00 +0000
+++ src/app/webbrowser/searchengine.cpp	2014-06-30 11:01:41 +0000
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This file is part of webbrowser-app.
+ *
+ * webbrowser-app 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; version 3.
+ *
+ * webbrowser-app 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, see <http://www.gnu.org/licenses/>.
+ */
+
+// local
+#include "searchengine.h"
+
+// Qt
+#include <QtCore/QDir>
+#include <QtCore/QFile>
+#include <QtCore/QStandardPaths>
+#include <QtCore/QXmlStreamReader>
+
+SearchEngine::SearchEngine(const QString& name, QObject* parent)
+    : QObject(parent)
+    , m_name(DEFAULT_SEARCH_NAME)
+    , m_description(DEFAULT_SEARCH_DESC)
+    , m_template(DEFAULT_SEARCH_TEMPLATE)
+{
+    QString searchenginesSubDir("searchengines");
+    QString filename = searchenginesSubDir + "/" + name + ".xml";
+    m_path = QStandardPaths::locate(QStandardPaths::DataLocation, filename);
+    if (!m_path.isEmpty()) {
+        parseOpenSearchDescription();
+    }
+}
+
+SearchEngine::SearchEngine(const SearchEngine& other)
+{
+    m_path = other.m_path;
+    m_name = other.m_name;
+    m_description = other.m_description;
+    m_template = other.m_template;
+}
+
+bool SearchEngine::isValid() const
+{
+    return (!m_name.isEmpty() && !m_template.isEmpty());
+}
+
+const QString& SearchEngine::name() const
+{
+    return m_name;
+}
+
+const QString& SearchEngine::description() const
+{
+    return m_description;
+}
+
+const QString& SearchEngine::urlTemplate() const
+{
+    return m_template;
+}
+
+void SearchEngine::parseOpenSearchDescription()
+{
+    QFile file(m_path);
+    if (!file.open(QIODevice::ReadOnly)) {
+        return;
+    }
+    QXmlStreamReader parser(&file);
+    while (!parser.atEnd()) {
+        parser.readNext();
+        if (parser.isStartElement()) {
+            QStringRef name = parser.name();
+            if (name == "ShortName") {
+                m_name = parser.readElementText();
+            } else if (name == "Description") {
+                m_description = parser.readElementText();
+            } else if (name == "Url") {
+                if (parser.attributes().value("type") == "text/html") {
+                    m_template = parser.attributes().value("template").toString();
+                }
+            }
+        }
+    }
+}

=== added file 'src/app/webbrowser/searchengine.h'
--- src/app/webbrowser/searchengine.h	1970-01-01 00:00:00 +0000
+++ src/app/webbrowser/searchengine.h	2014-06-30 11:01:41 +0000
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This file is part of webbrowser-app.
+ *
+ * webbrowser-app 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; version 3.
+ *
+ * webbrowser-app 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __SEARCH_ENGINE_H__
+#define __SEARCH_ENGINE_H__
+
+// local
+#include "config.h"
+
+// Qt
+#include <QtCore/QMetaType>
+#include <QtCore/QObject>
+#include <QtCore/QString>
+
+class SearchEngine : public QObject
+{
+    Q_OBJECT
+
+    Q_PROPERTY(QString name READ name CONSTANT)
+    Q_PROPERTY(QString description READ description CONSTANT)
+    Q_PROPERTY(QString template READ urlTemplate CONSTANT)
+
+public:
+    SearchEngine(const QString& name=DEFAULT_SEARCH_ENGINE, QObject* parent=0);
+    SearchEngine(const SearchEngine& other);
+
+    bool isValid() const;
+    const QString& name() const;
+    const QString& description() const;
+    const QString& urlTemplate() const;
+
+private:
+    QString m_path;
+    QString m_name;
+    QString m_description;
+    QString m_template;
+
+    void parseOpenSearchDescription();
+};
+
+Q_DECLARE_METATYPE(SearchEngine);
+
+#endif // __SEARCH_ENGINE_H__

=== modified file 'src/app/webbrowser/settings.cpp'
--- src/app/webbrowser/settings.cpp	2013-11-27 14:28:15 +0000
+++ src/app/webbrowser/settings.cpp	2014-06-30 11:01:41 +0000
@@ -19,18 +19,27 @@
 // local
 #include "settings.h"
 #include "config.h"
+#include "searchengine.h"
 
 // Qt
 #include <QtCore/QSettings>
 
 Settings::Settings(QObject* parent)
     : QObject(parent)
+    , m_searchengine(NULL)
 {
     QSettings settings(QCoreApplication::applicationName(), "settings");
     m_homepage = settings.value("homepage", QUrl(DEFAULT_HOMEPAGE)).toUrl();
+    QString name = settings.value("searchengine", QString(DEFAULT_SEARCH_ENGINE)).toString();
+    m_searchengine = new SearchEngine(name, this);
 }
 
 const QUrl& Settings::homepage() const
 {
     return m_homepage;
 }
+
+SearchEngine* Settings::searchEngine() const
+{
+    return m_searchengine;
+}

=== modified file 'src/app/webbrowser/settings.h'
--- src/app/webbrowser/settings.h	2013-11-25 16:04:05 +0000
+++ src/app/webbrowser/settings.h	2014-06-30 11:01:41 +0000
@@ -23,6 +23,8 @@
 #include <QtCore/QObject>
 #include <QtCore/QUrl>
 
+class SearchEngine;
+
 /*
  * Temporary helper class for read-only settings
  * until Settings support lands in the SDK.
@@ -35,9 +37,11 @@
     Settings(QObject* parent=0);
 
     const QUrl& homepage() const;
+    SearchEngine* searchEngine() const;
 
 private:
     QUrl m_homepage;
+    SearchEngine* m_searchengine;
 };
 
 #endif // __SETTINGS_H__

=== modified file 'src/app/webbrowser/webbrowser-app.cpp'
--- src/app/webbrowser/webbrowser-app.cpp	2014-05-05 12:01:32 +0000
+++ src/app/webbrowser/webbrowser-app.cpp	2014-06-30 11:01:41 +0000
@@ -23,6 +23,7 @@
 #include "history-timeframe-model.h"
 #include "history-domainlist-model.h"
 #include "history-domainlist-chronological-model.h"
+#include "searchengine.h"
 #include "settings.h"
 #include "tabs-model.h"
 #include "webbrowser-app.h"
@@ -38,6 +39,7 @@
 #include <QtCore/QMetaObject>
 #include <QtCore/QString>
 #include <QtCore/QTextStream>
+#include <QtCore/QVariant>
 #include <QtQml/QtQml>
 #include <QtQuick/QQuickWindow>
 
@@ -79,19 +81,20 @@
     qmlRegisterType<BookmarksModel>(uri, 0, 1, "BookmarksModel");
 
     if (BrowserApplication::initialize("webbrowser/webbrowser-app.qml")) {
+        Settings settings;
         m_window->setProperty("chromeless", m_arguments.contains("--chromeless"));
+        SearchEngine* searchEngine = settings.searchEngine();
+        searchEngine->setParent(m_window);
+        m_window->setProperty("searchEngine", QVariant::fromValue(searchEngine));
         QList<QUrl> urls = this->urls();
         if (urls.isEmpty()) {
-            Settings settings;
             urls.append(settings.homepage());
         }
         QObject* browser = (QObject*) m_window;
         Q_FOREACH(const QUrl& url, urls) {
             QMetaObject::invokeMethod(browser, "newTab", Q_ARG(QVariant, url), Q_ARG(QVariant, true));
         }
-
         m_component->completeCreate();
-
         return true;
     } else {
         return false;

=== modified file 'src/app/webbrowser/webbrowser-app.qml'
--- src/app/webbrowser/webbrowser-app.qml	2014-06-18 16:20:49 +0000
+++ src/app/webbrowser/webbrowser-app.qml	2014-06-30 11:01:41 +0000
@@ -21,6 +21,7 @@
 import Ubuntu.Components 0.1
 
 Window {
+    property alias searchEngine: browser.searchEngine
     property alias chromeless: browser.chromeless
     property alias developerExtrasEnabled: browser.developerExtrasEnabled
 

=== modified file 'tests/unittests/qml/tst_AddressBar.qml'
--- tests/unittests/qml/tst_AddressBar.qml	2014-06-06 17:01:55 +0000
+++ tests/unittests/qml/tst_AddressBar.qml	2014-06-30 11:01:41 +0000
@@ -70,8 +70,8 @@
 
     function test_search_url_data() {
         return [
-            {text: "lorem ipsum dolor sit amet", start: "https://google.com", query: "lorem+ipsum+dolor+sit+amet"},
-            {text: "ubuntu", start: "https://google.com", query: "ubuntu"},
+            {text: "lorem ipsum dolor sit amet", start: "http://www.ubuntu.com", query: "lorem+ipsum+dolor+sit+amet"},
+            {text: "ubuntu", start: "http://www.ubuntu.com", query: "ubuntu"},
         ]
     }
 
@@ -115,5 +115,6 @@
 
     AddressBar {
         id: addressBar
+        searchUrl: "http://www.ubuntu.com/search?q={searchTerms}"
     }
 }

=== modified file 'webbrowser-app.qmlproject'
--- webbrowser-app.qmlproject	2014-05-30 16:16:56 +0000
+++ webbrowser-app.qmlproject	2014-06-30 11:01:41 +0000
@@ -9,7 +9,7 @@
 
     Files {
         directory: "."
-        filter: "CMakeLists.txt"
+        filter: "CMakeLists.txt;README"
     }
 
     Files {