Merge lp:~ahayzen/ubuntu-ui-extras/printer-components-job-hold-release into lp:~phablet-team/ubuntu-ui-extras/printer-staging

[Andrew Hayzen]

* Add holdJob and releaseJob methods to Printers
* Add HeldRole to JobModel
* Add tests for hold and releasing a job
* Update example to show how hold and release work
* Update StateRole to return just the state, not text

* Add holdJob and releaseJob methods to Printers
* Add HeldRole to JobModel
* Add tests for hold and releasing a job
* Update example to show how hold and release work
* Update StateRole to return just the state, not text

=== modified file 'modules/Ubuntu/Components/Extras/Example/PrinterQueue.qml'
--- modules/Ubuntu/Components/Extras/Example/PrinterQueue.qml	2017-02-21 11:31:44 +0000
+++ modules/Ubuntu/Components/Extras/Example/PrinterQueue.qml	2017-03-01 15:31:37 +0000
@@ -46,20 +46,39 @@
                 }
                 delegate: ListItem {
                     height: modelLayout.height + (divider.visible ? divider.height : 0)
+                    trailingActions: ListItemActions {
+                        actions: [
+                            Action {
+                                iconName: model.held ? "media-playback-start" : "media-playback-pause"
+                                text: model.held ? "Release" : "Hold"
+
+                                onTriggered: {
+                                    if (model.held) {
+                                        Printers.releaseJob(printer.name, model.id);
+                                    } else {
+                                        Printers.holdJob(printer.name, model.id);
+                                    }
+                                }
+                            },
+                            Action {
+                                iconName: "cancel"
+                                text: "Cancel"
+
+                                onTriggered: Printers.cancelJob(printer.name, model.id);
+                            }
+                        ]
+                    }
+
                     ListItemLayout {
                         id: modelLayout
                         title.text: displayName
-                        subtitle.text: "Job: " + model.id + " State: " + model.state
+                        subtitle.text: model.title + " (" + model.id + ") State: " + model.state
                                        + " Color: " + model.colorModel + " CreationTime: "
                                        + model.creationTime + " PageRange: "
                                        + model.printRange + " Messages: " + model.messages;
                         subtitle.wrapMode: Text.WrapAtWordBoundaryOrAnywhere
                         subtitle.maximumLineCount: 3
                     }
-                    onClicked: {
-                        console.debug("Cancel:", printer.name, model.id);
-                        Printers.cancelJob(printer.name, model.id);
-                    }
                 }
                 model: printer.jobs
 

=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp	2017-02-23 14:04:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend.cpp	2017-03-01 15:31:37 +0000
@@ -139,6 +139,18 @@
     Q_UNUSED(name);
 }
 
+void PrinterBackend::holdJob(const QString &name, const int jobId)
+{
+    Q_UNUSED(jobId);
+    Q_UNUSED(name);
+}
+
+void PrinterBackend::releaseJob(const QString &name, const int jobId)
+{
+    Q_UNUSED(jobId);
+    Q_UNUSED(name);
+}
+
 int PrinterBackend::printFileToDest(const QString &filepath,
                             const QString &title,
                             const cups_dest_t *dest)

=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend.h'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend.h	2017-02-23 14:04:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend.h	2017-03-01 15:31:37 +0000
@@ -77,6 +77,8 @@
                                   const PrinterJob *options);
 
     virtual void cancelJob(const QString &name, const int jobId);
+    virtual void holdJob(const QString &name, const int jobId);
+    virtual void releaseJob(const QString &name, const int jobId);
     virtual int printFileToDest(const QString &filepath,
                                 const QString &title,
                                 const cups_dest_t *dest);

=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp	2017-02-24 12:53:34 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.cpp	2017-03-01 15:31:37 +0000
@@ -347,6 +347,20 @@
     }
 }
 
+void PrinterCupsBackend::holdJob(const QString &name, const int jobId)
+{
+    if (!m_client->printerHoldJob(name, jobId)) {
+        qWarning() << "Failed to hold job:" << jobId << "for" << name;
+    }
+}
+
+void PrinterCupsBackend::releaseJob(const QString &name, const int jobId)
+{
+    if (!m_client->printerReleaseJob(name, jobId)) {
+        qWarning() << "Failed to release job:" << jobId << "for" << name;
+    }
+}
+
 int PrinterCupsBackend::printFileToDest(const QString &filepath,
                                         const QString &title,
                                         const cups_dest_t *dest)

=== modified file 'modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h'
--- modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h	2017-02-24 12:53:34 +0000
+++ modules/Ubuntu/Components/Extras/Printers/backend/backend_cups.h	2017-03-01 15:31:37 +0000
@@ -71,6 +71,8 @@
                                   const PrinterJob *options) override;
 
     virtual void cancelJob(const QString &name, const int jobId) override;
+    virtual void holdJob(const QString &name, const int jobId) override;
+    virtual void releaseJob(const QString &name, const int jobId) override;
     virtual int printFileToDest(const QString &filepath,
                                 const QString &title,
                                 const cups_dest_t *dest) override;

=== modified file 'modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp'
--- modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp	2017-02-21 10:46:29 +0000
+++ modules/Ubuntu/Components/Extras/Printers/cups/ippclient.cpp	2017-03-01 15:31:37 +0000
@@ -173,6 +173,30 @@
     return postRequest(request, ppdFileName.toUtf8(), CupsResourceAdmin);
 }
 
+bool IppClient::printerHoldJob(const QString &printerName, const int jobId)
+{
+    ipp_t *request = ippNewRequest(IPP_HOLD_JOB);
+    addPrinterUri(request, printerName);
+    addRequestingUsername(request, NULL);
+
+    ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER,
+                  "job-id", jobId);
+
+    return sendRequest(request, CupsResourceJobs);
+}
+
+bool IppClient::printerReleaseJob(const QString &printerName, const int jobId)
+{
+    ipp_t *request = ippNewRequest(IPP_RELEASE_JOB);
+    addPrinterUri(request, printerName);
+    addRequestingUsername(request, NULL);
+
+    ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER,
+                  "job-id", jobId);
+
+    return sendRequest(request, CupsResourceJobs);
+}
+
 bool IppClient::printerSetDefault(const QString &printerName)
 {
     return sendNewSimpleRequest(CUPS_SET_DEFAULT, printerName.toUtf8(),
@@ -343,11 +367,10 @@
 
     // Construct request
     request = ippNewRequest(IPP_GET_JOB_ATTRIBUTES);
+
     QString uri = QStringLiteral("ipp://localhost/jobs/") + QString::number(jobId);
-    qDebug() << "URI:" << uri;
-
-    ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri", NULL, uri.toStdString().data());
-
+    ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
+                 "job-uri", NULL, uri.toStdString().data());
 
     // Send request and construct reply
     ipp_t *reply;

=== modified file 'modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h'
--- modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h	2017-02-21 10:46:29 +0000
+++ modules/Ubuntu/Components/Extras/Printers/cups/ippclient.h	2017-03-01 15:31:37 +0000
@@ -51,6 +51,8 @@
                                const QString &ppdFileName,
                                const QString &info,
                                const QString &location);
+    bool printerHoldJob(const QString &printerName, const int jobId);
+    bool printerReleaseJob(const QString &printerName, const int jobId);
     bool printerSetDefault(const QString &printerName);
     bool printerSetEnabled(const QString &printerName, const bool enabled);
     bool printerSetAcceptJobs(const QString &printerName, const bool accept,

=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp'
--- modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp	2017-02-23 14:04:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/jobmodel.cpp	2017-03-01 15:31:37 +0000
@@ -194,6 +194,9 @@
         case IdRole:
             ret = job->jobId();
             break;
+        case HeldRole:
+            ret = job->state() == PrinterEnum::JobState::Held;
+            break;
         case ImpressionsCompletedRole:
             ret = job->impressionsCompleted();
             break;
@@ -231,30 +234,7 @@
             ret = job->size();
             break;
         case StateRole:
-            // TODO: improve, for now have a switch
-            switch (job->state()) {
-            case PrinterEnum::JobState::Aborted:
-                ret = "Aborted";
-                break;
-            case PrinterEnum::JobState::Canceled:
-                ret = "Canceled";
-                break;
-            case PrinterEnum::JobState::Complete:
-                ret = "Compelete";
-                break;
-            case PrinterEnum::JobState::Held:
-                ret = "Held";
-                break;
-            case PrinterEnum::JobState::Pending:
-                ret = "Pending";
-                break;
-            case PrinterEnum::JobState::Processing:
-                ret = "Processing";
-                break;
-            case PrinterEnum::JobState::Stopped:
-                ret = "Stopped";
-                break;
-            }
+            ret = QVariant::fromValue<PrinterEnum::JobState>(job->state());
             break;
         case Qt::DisplayRole:
         case TitleRole:
@@ -283,6 +263,7 @@
         names[CreationTimeRole] = "creationTime";
         names[DuplexRole] = "duplexMode";
         names[ImpressionsCompletedRole] = "impressionsCompleted";
+        names[HeldRole] = "held";
         names[LandscapeRole] = "landscape";
         names[MessagesRole] = "messages";
         names[PrinterNameRole] = "printerName";

=== modified file 'modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h'
--- modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h	2017-02-21 10:46:29 +0000
+++ modules/Ubuntu/Components/Extras/Printers/models/jobmodel.h	2017-03-01 15:31:37 +0000
@@ -51,6 +51,7 @@
         CopiesRole,
         CreationTimeRole,
         DuplexRole,
+        HeldRole,
         ImpressionsCompletedRole,
         LandscapeRole,
         MessagesRole,

=== modified file 'modules/Ubuntu/Components/Extras/Printers/printer/printerjob.h'
--- modules/Ubuntu/Components/Extras/Printers/printer/printerjob.h	2017-02-23 14:04:26 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printer/printerjob.h	2017-03-01 15:31:37 +0000
@@ -58,8 +58,6 @@
     Q_PROPERTY(PrinterEnum::JobState state READ state NOTIFY stateChanged)
     Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY titleChanged)
     Q_PROPERTY(QString user READ user NOTIFY userChanged)
-
-    friend class PrinterCupsBackend;
 public:
     explicit PrinterJob(QString dest,
                         PrinterBackend *backend,
@@ -100,28 +98,28 @@
     Q_INVOKABLE void printFile(const QUrl &url);
     void setCollate(const bool collate);
     void setColorModel(const int colorModel);
+    void setCompletedTime(const QDateTime &completedTime);
     void setCopies(const int copies);
+    void setCreationTime(const QDateTime &creationTime);
     void setDuplexMode(const int duplexMode);
     void setImpressionsCompleted(const int &impressionsCompleted);
+    void setIsTwoSided(const bool isTwoSided);
     void setLandscape(const bool landscape);
+    void setMessages(const QStringList &messages);
     void setPrinter(QSharedPointer<Printer> printer);
     void setPrintRange(const QString &printRange);
     void setPrintRangeMode(const PrinterEnum::PrintRange printRangeMode);
+    void setProcessingTime(const QDateTime &processingTime);
     void setQuality(const int quality);
     void setReverse(const bool reverse);
+    void setSize(const int size);
+    void setState(const PrinterEnum::JobState &state);
     void setTitle(const QString &title);
+    void setUser(const QString &user);
 
     void updateFrom(QSharedPointer<PrinterJob> other);
 private Q_SLOTS:
     void loadDefaults();
-    void setCompletedTime(const QDateTime &completedTime);
-    void setCreationTime(const QDateTime &creationTime);
-    void setIsTwoSided(const bool isTwoSided);
-    void setMessages(const QStringList &messages);
-    void setProcessingTime(const QDateTime &processingTime);
-    void setSize(const int size);
-    void setState(const PrinterEnum::JobState &state);
-    void setUser(const QString &user);
 Q_SIGNALS:
     void collateChanged();
     void colorModelChanged();

=== modified file 'modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp'
--- modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp	2017-02-24 13:14:13 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printers/printers.cpp	2017-03-01 15:31:37 +0000
@@ -148,6 +148,16 @@
     m_backend->cancelJob(printerName, jobId);
 }
 
+void Printers::holdJob(const QString &printerName, const int jobId)
+{
+    m_backend->holdJob(printerName, jobId);
+}
+
+void Printers::releaseJob(const QString &printerName, const int jobId)
+{
+    m_backend->releaseJob(printerName, jobId);
+}
+
 void Printers::setDefaultPrinterName(const QString &name)
 {
     QString reply = m_backend->printerSetDefault(name);

=== modified file 'modules/Ubuntu/Components/Extras/Printers/printers/printers.h'
--- modules/Ubuntu/Components/Extras/Printers/printers/printers.h	2017-02-24 12:20:07 +0000
+++ modules/Ubuntu/Components/Extras/Printers/printers/printers.h	2017-03-01 15:31:37 +0000
@@ -63,6 +63,8 @@
 public Q_SLOTS:
     PrinterJob* createJob(const QString &printerName);
     void cancelJob(const QString &printerName, const int jobId);
+    void holdJob(const QString &printerName, const int jobId);
+    void releaseJob(const QString &printerName, const int jobId);
 
     /* Instructs us to start loading drivers and what have you. In most cases,
     the user is likely to merely configure existing printers/jobs. Loading

=== modified file 'tests/unittests/Printers/mockbackend.h'
--- tests/unittests/Printers/mockbackend.h	2017-02-24 12:20:07 +0000
+++ tests/unittests/Printers/mockbackend.h	2017-03-01 15:31:37 +0000
@@ -163,6 +163,38 @@
         }
     }
 
+    virtual void holdJob(const QString &name, const int jobId) override
+    {
+        for (int i=0; i < m_jobs.count(); i++) {
+            QSharedPointer<PrinterJob> job = m_jobs[i];
+
+            if (job->printerName() == name && job->jobId() == jobId) {
+                auto jobHeld = QSharedPointer<PrinterJob>(new PrinterJob(job->printerName(), this, jobId));
+                jobHeld->setState(PrinterEnum::JobState::Held);
+                m_jobs.replace(0, jobHeld);
+
+                Q_EMIT jobState(job->title(), "", job->printerName(), 1, "", true, job->jobId(), 4, "", "", 1);
+                break;
+            }
+        }
+    }
+
+    virtual void releaseJob(const QString &name, const int jobId) override
+    {
+        for (int i=0; i < m_jobs.count(); i++) {
+            QSharedPointer<PrinterJob> job = m_jobs[i];
+
+            if (job->printerName() == name && job->jobId() == jobId) {
+                auto jobRelease = QSharedPointer<PrinterJob>(new PrinterJob(job->printerName(), this, jobId));
+                jobRelease->setState(PrinterEnum::JobState::Pending);
+                m_jobs.replace(0, jobRelease);
+
+                Q_EMIT jobState(job->title(), "", job->printerName(), 1, "", true, job->jobId(), 4, "", "", 1);
+                break;
+            }
+        }
+    }
+
     virtual int printFileToDest(const QString &filepath,
                                 const QString &title,
                                 const cups_dest_t *dest) override

=== modified file 'tests/unittests/Printers/tst_printers.cpp'
--- tests/unittests/Printers/tst_printers.cpp	2017-02-24 12:20:07 +0000
+++ tests/unittests/Printers/tst_printers.cpp	2017-03-01 15:31:37 +0000
@@ -139,6 +139,58 @@
         QCOMPARE(args.at(1).toInt(), 0);
         QCOMPARE(args.at(2).toInt(), 0);
     }
+    void testHoldJob()
+    {
+        MockPrinterBackend *backend = new MockPrinterBackend;
+        JobModel *model = new JobModel(backend);
+        Printers p(backend);
+
+        // Add one.
+        QSharedPointer<PrinterJob> job = QSharedPointer<PrinterJob>(new PrinterJob("test-printer", backend));
+        backend->m_jobs << job;
+        backend->mockJobCreated("", "", "", 1, "", true, 100, 1, "", "", 1);
+
+        // Check it was added
+        QCOMPARE(model->count(), 1);
+        QCOMPARE(job->state(), PrinterEnum::JobState::Pending);
+
+        // Setup the spy
+        QSignalSpy dataChangedSpy(model, SIGNAL(dataChanged(const QModelIndex&, const QModelIndex&, const QVector<int>&)));
+
+        // Hold the job
+        p.holdJob(job->printerName(), job->jobId());
+
+        // Check item was removed
+        QTRY_COMPARE(dataChangedSpy.count(), 1);
+        QCOMPARE(job->state(), PrinterEnum::JobState::Held);
+    }
+    void testReleaseJob()
+    {
+        MockPrinterBackend *backend = new MockPrinterBackend;
+        JobModel *model = new JobModel(backend);
+        Printers p(backend);
+
+        // Add one.
+        QSharedPointer<PrinterJob> job = QSharedPointer<PrinterJob>(new PrinterJob("test-printer", backend));
+        backend->m_jobs << job;
+        backend->mockJobCreated("", "", "", 1, "", true, 100, 1, "", "", 1);
+
+        p.holdJob(job->printerName(), job->jobId());
+
+        // Check it was added and is in held state
+        QCOMPARE(model->count(), 1);
+        QCOMPARE(job->state(), PrinterEnum::JobState::Held);
+
+        // Setup the spy
+        QSignalSpy dataChangedSpy(model, SIGNAL(dataChanged(const QModelIndex&, const QModelIndex&, const QVector<int>&)));
+
+        // Release the job
+        p.releaseJob(job->printerName(), job->jobId());
+
+        // Check item was removed
+        QTRY_COMPARE(dataChangedSpy.count(), 1);
+        QCOMPARE(job->state(), PrinterEnum::JobState::Pending);
+    }
     void testPrinterRemove()
     {
         // Load the backend with a printer