Unity 8

Merge lp:~aacid/unity8/suspend_screenshoting into lp:unity8

suspend_screenshoting
Merge into trunk

Proposed by Albert Astals Cid on 2015-04-22

Status:	Merged
Approved by:	Michael Zanetti on 2015-06-30
Approved revision:	1755
Merged at revision:	1841
Proposed branch:	lp:~aacid/unity8/suspend_screenshoting
Merge into:	lp:unity8
Diff against target:	735 lines (+524/-22) 17 files modified debian/unity8-private.install (+1/-0) plugins/CMakeLists.txt (+1/-0) plugins/SessionGrabber/CMakeLists.txt (+8/-0) plugins/SessionGrabber/SessionGrabber.qmltypes (+23/-0) plugins/SessionGrabber/plugin.cpp (+27/-0) plugins/SessionGrabber/plugin.h (+32/-0) plugins/SessionGrabber/qmldir (+3/-0) plugins/SessionGrabber/sessiongrabber.cpp (+135/-0) plugins/SessionGrabber/sessiongrabber.h (+85/-0) qml/Stages/ApplicationWindow.qml (+46/-22) qml/Stages/Splash.qml (+2/-0) qml/Stages/SpreadDelegate.qml (+1/-0) tests/plugins/CMakeLists.txt (+1/-0) tests/plugins/SessionGrabber/CMakeLists.txt (+14/-0) tests/plugins/SessionGrabber/sessiongrabbertest.cpp (+79/-0) tests/plugins/SessionGrabber/sessiongrabbertest.qml (+22/-0) tests/qmltests/Stages/tst_ApplicationWindow.qml (+44/-0)
To merge this branch:	bzr merge lp:~aacid/unity8/suspend_screenshoting
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Needs Fixing on 2015-06-30
Michael Zanetti (community)			Abstain on 2015-06-30
Andrea Cimitan (community)			Abstain on 2015-04-30
Michał Sawicz		2015-04-22	Approve on 2015-04-30
Daniel d'Andrada (community)			Needs Information on 2015-04-30
Review via email: mp+257119@code.launchpad.net

Commit Message

Save screenshots of suspended apps to disk

Description of the Change

* Are there any related MPs required for this MP to build/function as expected?
No

* Did you perform an exploratory manual test run of your code change and any related functionality?
Not yet :D

* Did you make sure that your branch does not contain spurious tags?
Yes

* If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

* If you changed the UI, has there been a design review?
N/A

Michał Sawicz (saviq) wrote on 2015-04-23:

As mentioned, SessionScreenshoter could use a better name... For one, it could be SessionShotter (note double-t), as it's not shooting the screen, just the session ;). SessionGrabber? We already have a ScreenGrabber!

Generate qmltypes please.

Is the screenshot unloaded if app has a drawn-to surface?

Some clarification about the activity indicator - we do want it to run over either screenshot or splash screen *if* the app is active/focused, just not if it's in the background.

review: Needs Fixing

PS Jenkins bot (ps-jenkins) wrote on 2015-04-23:

FAILED: Continuous integration, rev:1743
http://jenkins.qa.ubuntu.com/job/unity8-ci/5606/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/2418/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/769/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/771/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/771/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/2416/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5606/rebuild

review: Needs Fixing (continuous-integration)

Albert Astals Cid (aacid) wrote on 2015-04-24:

> Is the screenshot unloaded if app has a drawn-to surface?
Yes, see

           Transition {
                from: "screenshot"; to: "surface"
                SequentialAnimation {
                    ...
                    PropertyAction { target: screenshotImage; property: "source"; value: "" }
                }
            }

PS Jenkins bot (ps-jenkins) wrote on 2015-04-24:

FAILED: Continuous integration, rev:1744
http://jenkins.qa.ubuntu.com/job/unity8-ci/5611/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/2426/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/774
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/776
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/776
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2111/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/2424
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/2424/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19892

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5611/rebuild

review: Needs Fixing (continuous-integration)

Albert Astals Cid (aacid) wrote on 2015-04-24:

> Generate qmltypes please.

Done

Albert Astals Cid (aacid) wrote on 2015-04-24:

> Some clarification about the activity indicator - we do want it to run over
> either screenshot or splash screen *if* the app is active/focused, just not if
> it's in the background.

This should be there now.

PS Jenkins bot (ps-jenkins) wrote on 2015-04-24:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5614/rebuild

review: Needs Fixing (continuous-integration)

Albert Astals Cid (aacid) wrote on 2015-04-28:

> I think we're unnecessarily complicating this by using the intermediate SOURCES variable, not sure why we started it ;)
Fixed

> Why not QStandardPaths::CacheLocation/app_shots/?
Utils/windowstatestorage.cpp is not using it so i did the same pattern.

> We tend to put the comma after newline.
Fixed, We need a bot to do this :D

> Any reason why not if (image.save(path))?
I think at some point i was returning b, changed it

> If you s/Screenshoter/Grabber/, likely s/take/grab/ here, too.
Done

> Maybe ::drop() or ::clear()... or just ::remove()? It feels weird to have a nice and short ::take() and then the verbose removeScreenshot().
Honestly i'd prefer not to, the thing is that we have "SessionGrabber", so it's quite clear what "grab" does, but "remove/drop/clear" seems like it may clear the grabber (i.e. for example reset parameters), not actually remove the screenshot.

> Third time, please factor out, maybe even cachePath(appId)?
Sure

> /me not totally familiar with QtConcurrent, can you explain why we need the QSharedPointer here?
You mean for the watcher or for the grab result?

> Typo "AppdId"
Fixed

> Typotoo.
Fixed

> As you rename... grabbed()?
Done

> If you rename ::removeScreenshot, likely rename this too, clearSessionGrab or so?
Not done since i didn't change the other one

> I'd probably use screenshoter.path || d.defaultScreenshot.
Ok, changed, not that it makes a difference

> Maybe add a comment why that?
Done

> Spinner active if running?
If the splash is still around (it'll go away as soon as the first frame is drawn), yes

> No spinner if stopped? Should be if stopped and !active?
How would one be stopped and active at the same time?

PS Jenkins bot (ps-jenkins) wrote on 2015-04-28:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5628/rebuild

review: Needs Fixing (continuous-integration)

Michał Sawicz (saviq) wrote on 2015-04-30:

>> Why not QStandardPaths::CacheLocation/app_shots/?
> Utils/windowstatestorage.cpp is not using it so i did the same pattern.

Yeah, but at least it writes in ~/.cache/*unity8*/, not in ~/.cache/ directly ;)

Also, there's no transition when screenshot is loaded over splashscreen.

review: Needs Fixing

PS Jenkins bot (ps-jenkins) wrote on 2015-04-30:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5649/rebuild

review: Needs Fixing (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-04-30:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5654/rebuild

review: Needs Fixing (continuous-integration)

Daniel d'Andrada (dandrader) wrote on 2015-04-30:

"""
added file 'plugins/SessionGrabber/sessiongrabber.cpp'
"""

Anything against using CamelCase for the file names? eg: SessionGrabber.cpp
What do we gain from making it all lower-case?

review: Needs Information

Michał Sawicz (saviq) wrote on 2015-04-30:

* Did you perform an exploratory manual test run of the code change and any related functionality?
Y
* Did CI run pass? If not, please explain why.
Some flakiness, will run again before top-approving.
* Did you make sure that the branch does not contain spurious tags?
Y

review: Approve

Albert Astals Cid (aacid) wrote on 2015-04-30:

> """
> added file 'plugins/SessionGrabber/sessiongrabber.cpp'
> """
>
> Anything against using CamelCase for the file names? eg: SessionGrabber.cpp
> What do we gain from making it all lower-case?

Having to press the shift key fewer times :D

Honestly we have half the plugins that use lowercase and half that use CamelCase, at some points we should decide what we want to use, but not sure this time should be now. Maybe on Dallas?

Andrea Cimitan (cimi) on 2015-04-30:

review: Needs Information

Andrea Cimitan (cimi) wrote on 2015-04-30:

After discussing with Gerry, eventually we might decide to have full resolution screenshots (maybe in black and white to indicate that is suspended), but we will fix it in a different branch

Andrea Cimitan (cimi) on 2015-04-30:

review: Abstain

PS Jenkins bot (ps-jenkins) wrote on 2015-04-30:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5657/rebuild

review: Needs Fixing (continuous-integration)

Albert Astals Cid (aacid) wrote on 2015-05-01:

> After discussing with Gerry, eventually we might decide to have full
> resolution screenshots (maybe in black and white to indicate that is
> suspended), but we will fix it in a different branch

FWIW the screenshot in disk is full resolution, it's the showing only that is not full resolution so won't lose resolution or have to re-take screenshots when changing it later

Michael Zanetti (mzanetti) wrote on 2015-06-16:

Needs a merge

review: Needs Fixing

Albert Astals Cid (aacid) wrote on 2015-06-22:

Merged

Michael Zanetti (mzanetti) wrote on 2015-06-24:

Doesn't compile any more after merging with trunk: https://launchpadlibrarian.net/209888034/buildlog_ubuntu-wily-i386.unity8_8.10%2B15.10.20150624-0ubuntu1_BUILDING.txt.gz

review: Needs Fixing

PS Jenkins bot (ps-jenkins) wrote on 2015-06-24:

FAILED: Continuous integration, rev:1753
http://jenkins.qa.ubuntu.com/job/unity8-ci/5883/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-wily-touch/191/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-wily-amd64-ci/163/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-wily-i386-ci/164/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-wily-armhf/191/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5883/rebuild

review: Needs Fixing (continuous-integration)

lp:~aacid/unity8/suspend_screenshoting updated on 2015-06-30

1754. By Albert Astals Cid on 2015-06-30: Merge unity8
1755. By Albert Astals Cid on 2015-06-30: Build++

Albert Astals Cid (aacid) wrote on 2015-06-30:

> Doesn't compile any more after merging with trunk:
> https://launchpadlibrarian.net/209888034/buildlog_ubuntu-
> wily-i386.unity8_8.10%2B15.10.20150624-0ubuntu1_BUILDING.txt.gz

Fixed.

Michael Zanetti (mzanetti) on 2015-06-30:

review: Abstain

PS Jenkins bot (ps-jenkins) wrote on 2015-06-30:

FAILED: Continuous integration, rev:1755
http://jenkins.qa.ubuntu.com/job/unity8-ci/5897/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-wily-touch/212
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-wily-amd64-ci/177
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-wily-i386-ci/178
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-wily-mako/140
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-wily-armhf/212
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-wily-armhf/212/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/21569

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5897/rebuild

review: Needs Fixing (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Albert Astals Cid

Mohammad Rakibul Hasan

Unity Team

 === modified file 'debian/unity8-private.install'
 --- debian/unity8-private.install	2015-04-21 15:22:53 +0000
 +++ debian/unity8-private.install	2015-06-30 11:41:39 +0000
@@ -8,6 +8,7 @@
  usr/lib/*/unity8/qml/Powerd
  usr/lib/*/unity8/qml/ScreenGrabber
  usr/lib/*/unity8/qml/SessionBroadcast
++usr/lib/*/unity8/qml/SessionGrabber
  usr/lib/*/unity8/qml/Ubuntu
  usr/lib/*/unity8/qml/Unity
  usr/lib/*/unity8/qml/Utils
 === modified file 'plugins/CMakeLists.txt'
 --- plugins/CMakeLists.txt	2014-12-12 10:00:31 +0000
 +++ plugins/CMakeLists.txt	2015-06-30 11:41:39 +0000
@@ -18,6 +18,7 @@
  add_subdirectory(Dash)
  add_subdirectory(Powerd)
  add_subdirectory(SessionBroadcast)
++add_subdirectory(SessionGrabber)
  add_subdirectory(ScreenGrabber)
  add_subdirectory(Ubuntu)
  add_subdirectory(Unity)
 === added directory 'plugins/SessionGrabber'
 === added file 'plugins/SessionGrabber/CMakeLists.txt'
 --- plugins/SessionGrabber/CMakeLists.txt	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/CMakeLists.txt	2015-06-30 11:41:39 +0000
@@ -0,0 +1,8 @@
++include_directories(
++  ${CMAKE_CURRENT_BINARY_DIR}
++)
++
++add_library(SessionGrabber-qml MODULE sessiongrabber.cpp plugin.cpp)
++qt5_use_modules(SessionGrabber-qml Qml Gui Quick Concurrent)
++
++add_unity8_plugin(SessionGrabber 0.1 SessionGrabber TARGETS SessionGrabber-qml)
 === added file 'plugins/SessionGrabber/SessionGrabber.qmltypes'
 --- plugins/SessionGrabber/SessionGrabber.qmltypes	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/SessionGrabber.qmltypes	2015-06-30 11:41:39 +0000
@@ -0,0 +1,23 @@
++import QtQuick.tooling 1.1
++
++// This file describes the plugin-supplied types contained in the library.
++// It is used for QML tooling purposes only.
++//
++// This file was auto-generated by:
++// 'qmlplugindump -notrelocatable SessionGrabber 0.1 plugins'
++
++Module {
++    Component {
++        name: "SessionGrabber"
++        prototype: "QObject"
++        exports: ["SessionGrabber/SessionGrabber 0.1"]
++        exportMetaObjectRevisions: [0]
++        Property { name: "appId"; type: "string" }
++        Property { name: "path"; type: "string"; isReadonly: true }
++        Property { name: "target"; type: "QQuickItem"; isPointer: true }
++        Signal { name: "appIdChanged" }
++        Signal { name: "screenshotTaken" }
++        Method { name: "take" }
++        Method { name: "removeScreenshot" }
++    }
++}
 === added file 'plugins/SessionGrabber/plugin.cpp'
 --- plugins/SessionGrabber/plugin.cpp	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/plugin.cpp	2015-06-30 11:41:39 +0000
@@ -0,0 +1,27 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ *
++ */
++
++#include "plugin.h"
++#include "sessiongrabber.h"
++
++#include <QtQml/qqml.h>
++
++void SessionGrabberPlugin::registerTypes(const char *uri)
++{
++    Q_ASSERT(uri == QLatin1String("SessionGrabber"));
++    qmlRegisterType<SessionGrabber>(uri, 0, 1, "SessionGrabber");
++}
 === added file 'plugins/SessionGrabber/plugin.h'
 --- plugins/SessionGrabber/plugin.h	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/plugin.h	2015-06-30 11:41:39 +0000
@@ -0,0 +1,32 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ *
++ */
++
++#ifndef SESSIONGRABBER_PLUGIN_H
++#define SESSIONGRABBER_PLUGIN_H
++
++#include <QtQml/QQmlExtensionPlugin>
++
++class SessionGrabberPlugin : public QQmlExtensionPlugin
++{
++    Q_OBJECT
++    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
++
++public:
++    void registerTypes(const char *uri);
++};
++
++#endif
 === added file 'plugins/SessionGrabber/qmldir'
 --- plugins/SessionGrabber/qmldir	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/qmldir	2015-06-30 11:41:39 +0000
@@ -0,0 +1,3 @@
++module SessionGrabber
++plugin SessionGrabber-qml
++typeinfo SessionGrabber.qmltypes
 === added file 'plugins/SessionGrabber/sessiongrabber.cpp'
 --- plugins/SessionGrabber/sessiongrabber.cpp	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/sessiongrabber.cpp	2015-06-30 11:41:39 +0000
@@ -0,0 +1,135 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ *
++ */
++
++#include "sessiongrabber.h"
++
++#include <QDebug>
++#include <QQuickItem>
++#include <QQuickItemGrabResult>
++#include <QtConcurrent>
++
++static QString cacheFolder()
++{
++    return QStandardPaths::writableLocation(QStandardPaths::CacheLocation) + "/app_shots/";
++}
++
++static QString cachePath(const QString &appId)
++{
++    return cacheFolder() + appId + ".png";
++}
++
++SessionGrabber::SessionGrabber(QObject *parent)
++    : QObject(parent)
++    , m_target(nullptr)
++    , m_watcher(nullptr)
++{
++}
++
++QString SessionGrabber::appId() const
++{
++    return m_appId;
++}
++
++void SessionGrabber::setAppId(const QString &appId)
++{
++    if (appId != m_appId) {
++        m_appId = appId;
++        const QString path = cachePath(appId);
++        if (QFile::exists(path)) {
++            setPath(path);
++        }
++    }
++}
++
++QQuickItem *SessionGrabber::target() const
++{
++    return m_target;
++}
++
++void SessionGrabber::setTarget(QQuickItem *target)
++{
++    if (target != m_target) {
++        m_target = target;
++        Q_EMIT targetChanged();
++    }
++}
++
++QString SessionGrabber::path() const
++{
++    return m_path;
++}
++
++void SessionGrabber::setPath(const QString &path)
++{
++    if (path != m_path) {
++        m_path = path;
++        Q_EMIT pathChanged();
++    }
++}
++
++static QString saveScreenshot(const QString &appId, const QSharedPointer<QQuickItemGrabResult> grabResult)
++{
++    const QImage image = grabResult->image();
++    const QString cPath = cacheFolder();
++    QDir d;
++    d.mkpath(cPath);
++    const QString path = cachePath(appId);
++    if (image.save(path)) {
++        return path;
++    } else {
++        return QString();
++    }
++}
++
++void SessionGrabber::grab()
++{
++    if (!m_grabResult.isNull()) {
++        qWarning() << "Asked to grab a screenshot when there's one already being grabbed, ignoring";
++        return;
++    }
++
++    if (m_target && !m_appId.isEmpty()) {
++        // grabToImage runs in a separate thread
++        m_grabResult = m_target->grabToImage();
++        connect(m_grabResult.data(), &QQuickItemGrabResult::ready, this, &SessionGrabber::grabReady);
++    } else {
++        qWarning() << "Can't grab screnshot: appId:" << m_appId << " target:" << m_target;
++    }
++}
++
++void SessionGrabber::removeScreenshot()
++{
++    const QString path = cachePath(m_appId);
++    QFile::remove(path);
++}
++
++void SessionGrabber::grabReady()
++{
++    QFuture<QString> f = QtConcurrent::run(saveScreenshot, m_appId, m_grabResult);
++    m_watcher = new QFutureWatcher<QString>(this);
++    m_watcher->setFuture(f);
++    connect(m_watcher, &QFutureWatcher<QString>::finished, this, &SessionGrabber::saveFinished);
++}
++
++void SessionGrabber::saveFinished()
++{
++    setPath(m_watcher->future().result());
++    delete m_watcher;
++    m_watcher = nullptr;
++    m_grabResult.clear();
++    Q_EMIT screenshotGrabbed();
++}
 === added file 'plugins/SessionGrabber/sessiongrabber.h'
 --- plugins/SessionGrabber/sessiongrabber.h	1970-01-01 00:00:00 +0000
 +++ plugins/SessionGrabber/sessiongrabber.h	2015-06-30 11:41:39 +0000
@@ -0,0 +1,85 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ *
++ */
++
++#ifndef SESSIONGRABBER_H
++#define SESSIONGRABBER_H
++
++#include <QObject>
++#include <QSharedPointer>
++#include <QFutureWatcher>
++
++class QQuickItem;
++class QQuickItemGrabResult;
++
++/**
++ * SessionGrabber saves to disk screenshots of the given item.
++ * Images are saved into $HOME/.cache/app_shots/appId.png
++ * It also handles giving back the screenshot path if it already exists (e.g. because a reboot)
++ */
++class SessionGrabber : public QObject
++{
++    Q_OBJECT
++
++    /// appId is the key of the screenshot name.
++    Q_PROPERTY(QString appId READ appId WRITE setAppId NOTIFY appIdChanged)
++
++    /// path where the screenshot is saved, can be empty if no screenshot has been grabbed yet.
++    Q_PROPERTY(QString path READ path NOTIFY pathChanged)
++
++    /// target item for the screenshot grabbing.
++    Q_PROPERTY(QQuickItem *target READ target WRITE setTarget NOTIFY targetChanged)
++
++public:
++    explicit SessionGrabber(QObject *parent = 0);
++
++    QString appId() const;
++    void setAppId(const QString &appId);
++
++    QQuickItem *target() const;
++    void setTarget(QQuickItem *target);
++
++    QString path() const;
++
++    /// Starts grabbing a screenshot. Emits screenshotGrabbed when ready.
++    Q_INVOKABLE void grab();
++
++    /// Removes the existing screenshot
++    Q_INVOKABLE void removeScreenshot();
++
++Q_SIGNALS:
++    void appIdChanged();
++    void targetChanged();
++    void pathChanged();
++
++    /// Signals screenshot grabbing has finished.
++    void screenshotGrabbed();
++
++private Q_SLOTS:
++    void grabReady();
++    void saveFinished();
++
++private:
++    void setPath(const QString &path);
++
++    QString m_appId;
++    QString m_path;
++    QQuickItem *m_target;
++    QFutureWatcher<QString> *m_watcher;
++    QSharedPointer<QQuickItemGrabResult> m_grabResult;
++};
++
++#endif
 === modified file 'qml/Stages/ApplicationWindow.qml'
 --- qml/Stages/ApplicationWindow.qml	2015-04-10 15:10:51 +0000
 +++ qml/Stages/ApplicationWindow.qml	2015-06-30 11:41:39 +0000
@@ -17,6 +17,7 @@
  import QtQuick 2.0
  import Ubuntu.Components 1.1
  import Unity.Application 0.1
++import SessionGrabber 0.1
  FocusScope {
      id: root
@@ -30,11 +31,16 @@
      property QtObject application
      property int surfaceOrientationAngle
++    function removeScreenshot() {
++        sessionGrabber.removeScreenshot();
++    }
++
      QtObject {
          id: d
          // helpers so that we don't have to check for the existence of an application everywhere
          // (in order to avoid breaking qml binding due to a javascript exception)
++        readonly property string appId: root.application ? root.application.appId : ""
          readonly property string name: root.application ? root.application.name : ""
          readonly property url icon: root.application ? root.application.icon : ""
          readonly property int applicationState: root.application ? root.application.state : -1
@@ -50,11 +56,11 @@
          property bool hadSurface: sessionContainer.surfaceContainer.hadSurface
          property bool needToTakeScreenshot:
--            sessionContainer.surface && d.surfaceInitialized && screenshotImage.status === Image.Null
--            && d.applicationState === ApplicationInfoInterface.Stopped
++            sessionContainer.surface && d.surfaceInitialized
++            && (d.applicationState === ApplicationInfoInterface.Stopped || d.applicationState === ApplicationInfoInterface.Suspended)
          onNeedToTakeScreenshotChanged: {
              if (needToTakeScreenshot) {
--                screenshotImage.take();
++                sessionGrabber.grab();
+             }
+         }
@@ -86,27 +92,9 @@
          onTriggered: { if (stateGroup.state === "surface") { d.surfaceOldEnoughToBeResized = true; } }
+     }
--    Image {
--        id: screenshotImage
--        objectName: "screenshotImage"
--        source: d.defaultScreenshot
--        anchors.fill: parent
--        antialiasing: !root.interactive
--
--        function take() {
--            // Format: "image://application/$APP_ID/$CURRENT_TIME_MS"
--            // eg: "image://application/calculator-app/123456"
--            var timeMs = new Date().getTime();
--            source = "image://application/" + root.application.appId + "/" + timeMs;
--        }
--
--        // Save memory by using a half-resolution (thus quarter size) screenshot
--        sourceSize.width: root.width / 2
--        sourceSize.height: root.height / 2
--    }
--
      Loader {
          id: splashLoader
++        objectName: "splashLoader"
          visible: active
          active: false
          anchors.fill: parent
@@ -120,10 +108,46 @@
                  backgroundColor: d.splashColor
                  headerColor: d.splashColorHeader
                  footerColor: d.splashColorFooter
++                activeSpinner: d.applicationState === ApplicationInfoInterface.Starting ||
++                               d.applicationState === ApplicationInfoInterface.Running
+             }
+         }
+     }
++    Image {
++        id: screenshotImage
++        objectName: "screenshotImage"
++        source: sessionGrabber.path || d.defaultScreenshot
++        anchors.fill: parent
++        antialiasing: !root.interactive
++        cache: false
++        asynchronous: true
++
++        // Save memory by using a half-resolution (thus quarter size) screenshot
++        sourceSize.width: root.width / 2
++        sourceSize.height: root.height / 2
++
++        ActivityIndicator {
++            id: activityIndicator
++            anchors.centerIn: parent
++            visible: running
++            running: stateGroup.state == "screenshot" &&
++                     (d.applicationState === ApplicationInfoInterface.Starting || d.applicationState === ApplicationInfoInterface.Running)
++        }
++    }
++
++    SessionGrabber {
++        id: sessionGrabber
++        appId: d.appId
++        target: root
++
++        onScreenshotGrabbed: {
++            // Need to reset to "" and back since it may be the same path with new content
++            screenshotImage.source = "";
++            screenshotImage.source = sessionGrabber.path;
++        }
++    }
++
      SessionContainer {
          id: sessionContainer
          // A fake application might not even have a session property.
 === modified file 'qml/Stages/Splash.qml'
 --- qml/Stages/Splash.qml	2014-09-16 13:48:40 +0000
 +++ qml/Stages/Splash.qml	2015-06-30 11:41:39 +0000
@@ -31,6 +31,7 @@
      property url icon
      property alias title: header.title
      property alias showHeader: header.visible
++    property alias activeSpinner: activityIndicator.running
      Ambiance.Palette {
          id: ambiancePalette
@@ -144,6 +145,7 @@
+     }
      ActivityIndicator {
++        id: activityIndicator
          anchors.centerIn: header.visible ? parent : undefined
          anchors.verticalCenterOffset: header.visible ? header.height / 2 : 0
 === modified file 'qml/Stages/SpreadDelegate.qml'
 --- qml/Stages/SpreadDelegate.qml	2015-05-11 14:36:03 +0000
 +++ qml/Stages/SpreadDelegate.qml	2015-06-30 11:41:39 +0000
@@ -397,6 +397,7 @@
                  if (!running) {
                      dragArea.moving = false;
                      if (requestClose) {
++                        appWindow.removeScreenshot();
                          root.closed();
                      } else {
                          dragArea.distance = 0;
 === modified file 'tests/plugins/CMakeLists.txt'
 --- tests/plugins/CMakeLists.txt	2014-12-12 10:00:31 +0000
 +++ tests/plugins/CMakeLists.txt	2015-06-30 11:41:39 +0000
@@ -2,6 +2,7 @@
  add_subdirectory(Greeter)
  add_subdirectory(LightDM)
  add_subdirectory(Dash)
++add_subdirectory(SessionGrabber)
  add_subdirectory(Ubuntu)
  add_subdirectory(Unity)
  add_subdirectory(Utils)
 === added directory 'tests/plugins/SessionGrabber'
 === added file 'tests/plugins/SessionGrabber/CMakeLists.txt'
 --- tests/plugins/SessionGrabber/CMakeLists.txt	1970-01-01 00:00:00 +0000
 +++ tests/plugins/SessionGrabber/CMakeLists.txt	2015-06-30 11:41:39 +0000
@@ -0,0 +1,14 @@
++add_executable(SessionGrabberTestExec
++    sessiongrabbertest.cpp
++    ${CMAKE_SOURCE_DIR}/plugins/SessionGrabber/sessiongrabber.cpp
++    )
++qt5_use_modules(SessionGrabberTestExec Core Quick Test Concurrent)
++
++add_definitions(-DCURRENT_SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}")
++
++include_directories(
++    ${CMAKE_CURRENT_BINARY_DIR}
++    ${CMAKE_SOURCE_DIR}/plugins/SessionGrabber
++    )
++
++add_unity8_uitest(SessionGrabber SessionGrabberTestExec)
 === added file 'tests/plugins/SessionGrabber/sessiongrabbertest.cpp'
 --- tests/plugins/SessionGrabber/sessiongrabbertest.cpp	1970-01-01 00:00:00 +0000
 +++ tests/plugins/SessionGrabber/sessiongrabbertest.cpp	2015-06-30 11:41:39 +0000
@@ -0,0 +1,79 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ */
++
++#include <QtTestGui>
++#include <QQuickItem>
++#include <QQuickView>
++#include <QSignalSpy>
++
++#include "sessiongrabber.h"
++
++class SessionGrabberTest : public QObject
++{
++    Q_OBJECT
++
++private Q_SLOTS:
++
++    void init()
++    {
++        view = new QQuickView();
++        view->setSource(QUrl::fromLocalFile(CURRENT_SOURCE_DIR "/sessiongrabbertest.qml"));
++        view->show();
++        QTest::qWaitForWindowExposed(view);
++    }
++
++    void testSessionGrabber()
++    {
++        SessionGrabber s;
++        s.setAppId("test-app-id");
++        s.setTarget(view->rootObject());
++        QSignalSpy spy(&s, &SessionGrabber::screenshotGrabbed);
++
++        QVERIFY(!QFile::exists(s.path()));
++
++        view->rootObject()->setProperty("color", "red");
++        s.grab();
++        spy.wait();
++
++        QVERIFY(QFile::exists(s.path()));
++        QImage image(s.path());
++        QCOMPARE(image.pixel(0, 0), qRgb(255, 0, 0));
++
++        view->rootObject()->setProperty("color", "blue");
++        s.grab();
++        spy.wait();
++
++        QVERIFY(QFile::exists(s.path()));
++        image = QImage(s.path());
++        QCOMPARE(image.pixel(0, 0), qRgb(0, 0, 255));
++
++        s.removeScreenshot();
++
++        QVERIFY(!QFile::exists(s.path()));
++    }
++
++    void cleanup()
++    {
++        delete view;
++    }
++
++private:
++    QQuickView *view;
++};
++
++QTEST_MAIN(SessionGrabberTest)
++
++#include "sessiongrabbertest.moc"
 === added file 'tests/plugins/SessionGrabber/sessiongrabbertest.qml'
 --- tests/plugins/SessionGrabber/sessiongrabbertest.qml	1970-01-01 00:00:00 +0000
 +++ tests/plugins/SessionGrabber/sessiongrabbertest.qml	2015-06-30 11:41:39 +0000
@@ -0,0 +1,22 @@
++/*
++ * Copyright (C) 2015 Canonical, Ltd.
++ *
++ * 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; version 3.
++ *
++ * 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, see <http://www.gnu.org/licenses/>.
++ */
++
++import QtQuick 2.4
++
++Rectangle {
++    width: 100
++    height: 100
++}
 === modified file 'tests/qmltests/Stages/tst_ApplicationWindow.qml'
 --- tests/qmltests/Stages/tst_ApplicationWindow.qml	2015-03-06 04:44:11 +0000
 +++ tests/qmltests/Stages/tst_ApplicationWindow.qml	2015-06-30 11:41:39 +0000
@@ -35,6 +35,9 @@
          root.fakeApplication.manualSurfaceCreation = true;
          root.fakeApplication.setState(ApplicationInfoInterface.Starting);
+     }
++    Component.onDestruction: {
++        applicationWindowLoader.item.removeScreenshot();
++    }
      property QtObject fakeApplication: null
      readonly property var fakeSession: fakeApplication ? fakeApplication.session : null
@@ -331,6 +334,40 @@
              tryCompare(screenshotImage, "status", Image.Null);
+         }
++        function test_suspendrestartApp() {
++            var screenshotImage = findChild(applicationWindowLoader.item, "screenshotImage");
++
++            initSession();
++            setApplicationState(appRunning);
++            tryCompare(stateGroup, "state", "surface");
++            waitUntilTransitionsEnd();
++
++            setApplicationState(appSuspended);
++
++            cleanupSession();
++
++            tryCompare(stateGroup, "state", "screenshot");
++            waitUntilTransitionsEnd();
++            tryCompare(fakeApplication, "session", null);
++
++            // and restart it
++            setApplicationState(appStarting);
++
++            waitUntilTransitionsEnd();
++            verify(stateGroup.state === "screenshot");
++            verify(fakeSession === null);
++
++            setApplicationState(appRunning);
++
++            waitUntilTransitionsEnd();
++            verify(stateGroup.state === "screenshot");
++
++            initSession();
++
++            tryCompare(stateGroup, "state", "surface");
++            tryCompare(screenshotImage, "status", Image.Null);
++        }
++
          function test_appCrashed() {
              initSession();
              setApplicationState(appRunning);
@@ -408,5 +445,12 @@
              applicationWindowLoader.item.interactive = true;
              compare(fakeSession.surface.activeFocus, true);
+         }
++
++        function test_no_spinner_if_stopped() {
++            setApplicationState(appStopped);
++            tryCompare(stateGroup, "state", "splashScreen");
++            var splashLoader = findChild(applicationWindowLoader.item, "splashLoader");
++            verify(!splashLoader.item.activeSpinner);
++        }
+     }
+ }