Merge lp:~jonas-drange/ubuntu-ui-extras/shared into lp:~phablet-team/ubuntu-ui-extras/printer-staging

[Jonas G. Drange]

adds read/write of the shared property

adds read/write of the shared property

[Andrew Hayzen (ahayzen)]

The code looks good, can you add the shared option as a delegate in the examples? (so that we can easily test)

review: Needs Fixing

[lp:~jonas-drange/ubuntu-ui-extras/shared]

143. By Jonas G. Drange on 2017-03-03

adds delegate for shared

[Andrew Hayzen (ahayzen)]

LGTM :-)

review: Approve

=== modified file 'modules/Ubuntu/Components/Extras/Example/Printers.qml'
--- modules/Ubuntu/Components/Extras/Example/Printers.qml	2017-03-02 15:08:24 +0000
+++ modules/Ubuntu/Components/Extras/Example/Printers.qml	2017-03-03 15:07:56 +0000
@@ -134,6 +134,19 @@
                             left: parent.left
                             right: parent.right
                         }
+                        text: "Shared"
+
+                        control: Switch {
+                            checked: printer.shared
+                            onCheckedChanged: printer.shared = checked
+                        }
+                    }
+
+                    ListItems.Standard {
+                        anchors {
+                            left: parent.left
+                            right: parent.right
+                        }
                         text: "Jobs"
                         progression: true
                         onClicked: pageStack.push(jobPage, { printer: printer })
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp	2017-03-01 12:53:55 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp	2017-03-03 15:07:56 +0000
@@ -91,6 +91,14 @@
     return QString();
 }
 
+QString PrinterBackend::printerSetShared(const QString &name,
+                                         const bool shared)
+{
+    Q_UNUSED(name);
+    Q_UNUSED(shared);
+    return QString();
+}
+
 QString PrinterBackend::printerSetInfo(const QString &name,
                                        const QString &info)
 {
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend.h'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend.h	2017-03-01 12:53:55 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend.h	2017-03-03 15:07:56 +0000
@@ -63,6 +63,8 @@
         const QString &name,
         const bool accept,
         const QString &reason = QString::null);
+    virtual QString printerSetShared(const QString &name,
+                                     const bool shared);
     virtual QString printerSetInfo(const QString &name,
                                    const QString &info);
     virtual QString printerAddOption(const QString &name,
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp	2017-03-02 14:29:46 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp	2017-03-03 15:07:56 +0000
@@ -179,6 +179,16 @@
     return QString();
 }
 
+QString PrinterCupsBackend::printerSetShared(const QString &name,
+                                             const bool shared)
+{
+    if (!m_client->printerSetShared(name, shared)) {
+        return m_client->getLastError();
+    }
+    return QString();
+}
+
+
 QString PrinterCupsBackend::printerSetInfo(const QString &name,
                                            const QString &info)
 {
@@ -309,6 +319,9 @@
             } else {
                 ret[option] = QString();
             }
+        } else if (option == QStringLiteral("Shared") && dest) {
+            ret[option] = cupsGetOption("printer-is-shared",
+                                        dest->num_options, dest->options);
         }
     }
     return ret;
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h	2017-03-02 14:28:53 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h	2017-03-03 15:07:56 +0000
@@ -55,6 +55,8 @@
         const QString &name,
         const bool accept,
         const QString &reason = QString::null) override;
+    virtual QString printerSetShared(const QString &name,
+                                     const bool shared) override;
     virtual QString printerSetInfo(const QString &name,
                                    const QString &info) override;
     virtual QString printerAddOption(const QString &name,
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend_pdf.cpp'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend_pdf.cpp	2017-03-02 13:50:54 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend_pdf.cpp	2017-03-03 15:07:56 +0000
@@ -65,6 +65,8 @@
             ret[option] = QLatin1String("");
         } else if (option == QLatin1String("DeviceUri")) {
             ret[option] = QLatin1String("");
+        } else if (option == QLatin1String("Shared")) {
+            ret[option] = false;
         } else {
             throw std::invalid_argument("Invalid value for PDF printer: " + option.toStdString());
         }
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp'
--- modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp	2017-03-02 14:52:47 +0000
+++ modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp	2017-03-03 15:07:56 +0000
@@ -250,6 +250,26 @@
     }
 }
 
+bool IppClient::printerSetShared(const QString &printerName, const bool shared)
+{
+    ipp_t *request;
+
+    if (!isPrinterNameValid(printerName)) {
+        setInternalStatus(QString("%1 is not a valid printer name.").arg(printerName));
+        return false;
+    }
+
+    request = ippNewRequest(CUPS_ADD_MODIFY_PRINTER);
+    addPrinterUri(request, printerName);
+    addRequestingUsername(request, NULL);
+    ippAddBoolean(request, IPP_TAG_OPERATION,
+                  "printer-is-shared", shared ? 1 : 0);
+
+    /* TODO: The request will fail if this was a printer class, and it should
+    be retried. */
+
+    return sendRequest(request, CupsResourceAdmin);
+}
 
 bool IppClient::printerClassSetInfo(const QString &name,
                                        const QString &info)
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h'
--- modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h	2017-03-02 14:28:53 +0000
+++ modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h	2017-03-03 15:07:56 +0000
@@ -57,6 +57,7 @@
     bool printerSetEnabled(const QString &printerName, const bool enabled);
     bool printerSetAcceptJobs(const QString &printerName, const bool accept,
                               const QString &reason);
+    bool printerSetShared(const QString &printerName, const bool shared);
     bool printerClassSetInfo(const QString &name, const QString &info);
     bool printerClassSetOption(const QString &name, const QString &option,
                                const QStringList &values);
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/printermodel.cpp'
--- modules/Ubuntu/Components/Extras/Printers/models/printermodel.cpp	2017-03-02 14:28:53 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/printermodel.cpp	2017-03-03 15:07:56 +0000
@@ -295,6 +295,9 @@
         case AcceptJobsRole:
             ret = printer->acceptJobs();
             break;
+        case SharedRole:
+            ret = printer->shared();
+            break;
         }
     }
 
@@ -350,6 +353,9 @@
         case AcceptJobsRole:
             printer->setAcceptJobs(value.toBool());
             break;
+        case SharedRole:
+            printer->setShared(value.toBool());
+            break;
         }
     }
 
@@ -372,6 +378,7 @@
         names[MakeRole] = "make";
         names[EnabledRole] = "printerEnabled";
         names[AcceptJobsRole] = "acceptJobs";
+        names[SharedRole] = "shared";
         names[PrintQualityRole] = "printQuality";
         names[SupportedPrintQualitiesRole] = "supportedPrintQualities";
         names[DescriptionRole] = "description";
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/printermodel.h'
--- modules/Ubuntu/Components/Extras/Printers/models/printermodel.h	2017-03-02 14:28:53 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/printermodel.h	2017-03-03 15:07:56 +0000
@@ -52,6 +52,7 @@
         LocationRole,
         EnabledRole,
         AcceptJobsRole,
+        SharedRole,
         PrintQualityRole,
         SupportedPrintQualitiesRole,
         DescriptionRole,
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/printer/printer.cpp'
--- modules/Ubuntu/Components/Extras/Printers/printer/printer.cpp	2017-03-02 15:39:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printer/printer.cpp	2017-03-03 15:07:56 +0000
@@ -84,11 +84,17 @@
     m_stateMessage = serverAttrs.value(QStringLiteral("StateMessage")).toString();
 }
 
+
 void Printer::updateDeviceUri(const QMap<QString, QVariant> &serverAttrs)
 {
     m_deviceUri = serverAttrs.value(QStringLiteral("DeviceUri")).toString();
 }
 
+void Printer::updateShared(const QMap<QString, QVariant> &serverAttrs)
+{
+    m_shared = serverAttrs.value(QStringLiteral("Shared")).toBool();
+}
+
 void Printer::loadAttributes()
 {
     auto opts = QStringList({
@@ -98,7 +104,8 @@
         QStringLiteral("DefaultPrintQuality"),
         QStringLiteral("SupportedPrintQualities"),
         QStringLiteral("StateMessage"),
-        QStringLiteral("DeviceUri")
+        QStringLiteral("DeviceUri"),
+        QStringLiteral("Shared")
     });
     auto result = m_backend->printerGetOptions(name(), opts);
 
@@ -107,6 +114,7 @@
     updatePrintQualities(result);
     updateLastMessage(result);
     updateDeviceUri(result);
+    updateShared(result);
 }
 
 ColorModel Printer::defaultColorModel() const
@@ -211,6 +219,11 @@
     return m_backend->state();
 }
 
+bool Printer::shared() const
+{
+    return m_shared;
+}
+
 bool Printer::acceptJobs() const
 {
     return m_acceptJobs;
@@ -283,6 +296,16 @@
     }
 }
 
+void Printer::setShared(const bool shared)
+{
+    if (this->shared() != shared) {
+        QString reply = m_backend->printerSetShared(name(), shared);
+        if (!reply.isEmpty()) {
+            qWarning() << Q_FUNC_INFO << "failed to set shared:" << reply;
+        }
+    }
+}
+
 void Printer::setDefaultPrintQuality(const PrintQuality &quality)
 {
     if (defaultPrintQuality() == quality) {
@@ -344,7 +367,8 @@
             && enabled() == other->enabled()
             && state() == other->state()
             && lastMessage() == other->lastMessage()
-            && deviceUri() == other->deviceUri();
+            && deviceUri() == other->deviceUri()
+            && shared() == other->shared();
 }
 
 void Printer::updateFrom(QSharedPointer<Printer> other)
 
=== modified file 'modules/Ubuntu/Components/Extras/Printers/printer/printer.h'
--- modules/Ubuntu/Components/Extras/Printers/printer/printer.h	2017-03-02 14:41:00 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printer/printer.h	2017-03-03 15:07:56 +0000
@@ -60,6 +60,7 @@
     PrinterEnum::AccessControl accessControl() const;
     PrinterEnum::ErrorPolicy errorPolicy() const;
     PrinterEnum::State state() const;
+    bool shared() const;
     bool acceptJobs() const;
     bool holdsDefinition() const;
     QString lastMessage() const;
@@ -72,6 +73,7 @@
     void setDefaultDuplexMode(const PrinterEnum::DuplexMode &duplexMode);
     void setEnabled(const bool enabled);
     void setAcceptJobs(const bool accepting);
+    void setShared(const bool shared);
     void setDefaultPrintQuality(const PrintQuality &quality);
     void setDefaultPageSize(const QPageSize &pageSize);
     void setJobModel(JobModel* jobModel);
@@ -96,6 +98,7 @@
     void updatePrintQualities(const QMap<QString, QVariant> &serverAttrs);
     void updateLastMessage(const QMap<QString, QVariant> &serverAttrs);
     void updateDeviceUri(const QMap<QString, QVariant> &serverAttrs);
+    void updateShared(const QMap<QString, QVariant> &serverAttrs);
     void loadAttributes();
 
     JobFilter m_jobs;
@@ -105,6 +108,7 @@
     PrintQuality m_defaultPrintQuality;
     QList<PrintQuality> m_supportedPrintQualities;
     bool m_acceptJobs;
+    bool m_shared;
     QString m_deviceUri;
 
     QString m_stateMessage;
 
=== modified file 'tests/unittests/Printers/mockbackend.h'
--- tests/unittests/Printers/mockbackend.h	2017-03-01 18:11:04 +0000
+++ tests/unittests/Printers/mockbackend.h	2017-03-03 15:07:56 +0000
@@ -105,6 +105,13 @@
         return returnValue;
     }
 
+    virtual QString printerSetShared(const QString &name,
+                                     const bool shared) override
+    {
+        printerOptions[name].insert("Shared", shared);
+        return returnValue;
+    }
+
     virtual QString printerSetInfo(const QString &name,
                                    const QString &info) override
     {
 
=== modified file 'tests/unittests/Printers/tst_printer.cpp'
--- tests/unittests/Printers/tst_printer.cpp	2017-03-02 14:41:00 +0000
+++ tests/unittests/Printers/tst_printer.cpp	2017-03-03 15:07:56 +0000
@@ -289,6 +289,32 @@
         p2.setAcceptJobs(false);
         QVERIFY(!backend->printerOptions[m_printerName]["AcceptJobs"].toBool());
     }
+    void testShared()
+    {
+        MockPrinterBackend *backend = new MockPrinterBackend(m_printerName);
+
+        backend->printerOptions[m_printerName].insert("Shared", false);
+        Printer p(backend);
+        QVERIFY(!p.shared());
+
+        backend->printerOptions[m_printerName].insert("Shared", true);
+        Printer p2(backend);
+        QVERIFY(p2.shared());
+    }
+    void testSetShared()
+    {
+        MockPrinterBackend *backend = new MockPrinterBackend(m_printerName);
+
+        backend->printerOptions[m_printerName].insert("Shared", false);
+        Printer p(backend);
+        p.setShared(true);
+        QVERIFY(backend->printerOptions[m_printerName]["Shared"].toBool());
+
+        backend->printerOptions[m_printerName].insert("Shared", true);
+        Printer p2(backend);
+        p2.setShared(false);
+        QVERIFY(!backend->printerOptions[m_printerName]["Shared"].toBool());
+    }
     void testJobs()
     {
         JobModel jobs;
 
=== modified file 'tests/unittests/Printers/tst_printermodel.cpp'
--- tests/unittests/Printers/tst_printermodel.cpp	2017-03-02 14:41:00 +0000
+++ tests/unittests/Printers/tst_printermodel.cpp	2017-03-03 15:07:56 +0000
@@ -362,6 +362,27 @@
         QCOMPARE(m_model->data(m_model->index(2), PrinterModel::AcceptJobsRole).toBool(),
                  true);
     }
+    void testSharedRole()
+    {
+        MockPrinterBackend* backendA = new MockPrinterBackend("a-printer");
+        backendA->printerOptions["a-printer"].insert("Shared", false);
+
+        auto printerA = QSharedPointer<Printer>(new Printer(backendA));
+        m_backend->mockPrinterLoaded(printerA);
+
+        MockPrinterBackend* backendB = new MockPrinterBackend("b-printer");
+        backendB->printerOptions["b-printer"].insert("Shared", true);
+
+        auto printerB = QSharedPointer<Printer>(new Printer(backendB));
+        m_backend->mockPrinterLoaded(printerB);
+
+        QCOMPARE(m_model->data(m_model->index(0), PrinterModel::SharedRole).toBool(),
+                 false);
+        QCOMPARE(m_model->data(m_model->index(1), PrinterModel::SharedRole).toBool(),
+                 false);
+        QCOMPARE(m_model->data(m_model->index(2), PrinterModel::SharedRole).toBool(),
+                 true);
+    }
     void testPrintQualityRole()
     {
         PrintQuality a;