Merge lp:~charlesk/keeper/remove-abandoned-storage-prototype into lp:keeper

[Charles Kerr]

remove unnecessary storage interface code.

This MR removes some unnecessary storage interface code that I experimented with briefly before my NOLA trip.

[Xavi Garcia (xavi-garcia-mena)]

LGTM

review: Approve

[lp:~charlesk/keeper/remove-abandoned-storage-prototype]

41. By Charles Kerr on 2016-07-21

sync with trunk

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2016-07-06 19:54:34 +0000
+++ src/CMakeLists.txt	2016-07-21 04:25:11 +0000
@@ -4,7 +4,6 @@
 )
 
 add_subdirectory(qdbus-stubs)
-add_subdirectory(storage)
 add_subdirectory(cli)
 add_subdirectory(service)
 add_subdirectory(util)

=== modified file 'src/cli/CMakeLists.txt'
--- src/cli/CMakeLists.txt	2016-06-08 16:40:34 +0000
+++ src/cli/CMakeLists.txt	2016-07-21 04:25:11 +0000
@@ -14,7 +14,6 @@
 
 target_link_libraries(
   ${CLI_EXEC}
-  storage
   util
   qdbus-stubs
   Qt5::Core

=== modified file 'src/service/CMakeLists.txt'
--- src/service/CMakeLists.txt	2016-07-07 13:59:14 +0000
+++ src/service/CMakeLists.txt	2016-07-21 04:25:11 +0000
@@ -35,7 +35,6 @@
 target_link_libraries(
   ${SERVICE_EXEC}
   ${SERVICE_LIB}
-  storage
   util
   qdbus-stubs
   storage-framework

=== removed directory 'src/storage'
=== removed file 'src/storage/CMakeLists.txt'
--- src/storage/CMakeLists.txt	2016-05-30 02:16:12 +0000
+++ src/storage/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-include_directories(${CMAKE_CURRENT_BINARY_DIR})
-
-set(STORAGE_SOURCES
-    storage.cpp
-    internal/local-storage.cpp
-    storage-factory.cpp
-)
-
-add_library(storage STATIC ${STORAGE_SOURCES})

=== removed directory 'src/storage/internal'
=== removed file 'src/storage/internal/local-storage.cpp'
--- src/storage/internal/local-storage.cpp	2016-05-30 02:16:12 +0000
+++ src/storage/internal/local-storage.cpp	1970-01-01 00:00:00 +0000
@@ -1,122 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#include <storage/internal/local-storage.h>
-
-#include <QDir>
-#include <QStandardPaths>
-#include <QtDebug>
-
-namespace storage
-{
-namespace internal
-{
-
-class LocalStorage::Impl
-{
-public:
-
-    Impl()
-    {
-        initBackupsDir();
-    }
-
-    ~Impl()
-    {
-    }
-
-    QVector<BackupInfo>
-    getBackups()
-    {
-        return QVector<BackupInfo>();
-    }
-
-    QSharedPointer<QIODevice>
-    startRestore(const QString& /*uuid*/)
-    {
-        return QSharedPointer<QIODevice>();
-    }
-
-    QSharedPointer<QIODevice>
-    startBackup(const BackupInfo& /*info*/)
-    {
-        return QSharedPointer<QIODevice>();
-    }
-
-private:
-
-    void
-    initBackupsDir()
-    {
-        static constexpr char const * DIRNAME {"Ubuntu Backups"};
-
-        auto path = QStandardPaths::locate(QStandardPaths::AppDataLocation,
-                                           DIRNAME,
-                                           QStandardPaths::LocateDirectory);
-        if (path.isEmpty())
-        {
-            QDir parent(QStandardPaths::writableLocation(QStandardPaths::AppDataLocation));
-            parent.mkpath(DIRNAME);
-            path = parent.absoluteFilePath(DIRNAME);
-        }
-
-        QDir dir(path);
-        if (!dir.exists())
-            qCritical() << path << " should exist but doesn't.";
-
-        backupsDir_ = dir;
-    }
-
-    QDir backupsDir_ {};
-};
-
-/***
-****
-***/
-
-LocalStorage::LocalStorage():
-    impl_{new Impl{}}
-{
-}
-
-LocalStorage::~LocalStorage()
-{
-}
-
-QVector<BackupInfo>
-LocalStorage::getBackups()
-{
-    return impl_->getBackups();
-}
-
-QSharedPointer<QIODevice>
-LocalStorage::startRestore(const QString& uuid)
-{
-    return impl_->startRestore(uuid);
-}
-
-QSharedPointer<QIODevice>
-LocalStorage::startBackup(const BackupInfo& info)
-{
-    return impl_->startBackup(info);
-}
-
-} // namespace internal
-
-} // namespace storage

=== removed file 'src/storage/internal/local-storage.h'
--- src/storage/internal/local-storage.h	2016-05-30 02:16:12 +0000
+++ src/storage/internal/local-storage.h	1970-01-01 00:00:00 +0000
@@ -1,57 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#pragma once
-
-#include <storage/storage.h>
-
-#include <memory> // unique_ptr
-
-namespace storage
-{
-namespace internal
-{
-
-// TODO: use the Qt pimpl macros
-class LocalStorage final: public Storage
-{
-public:
-
-    LocalStorage();
-    virtual ~LocalStorage();
-
-    LocalStorage(LocalStorage&&) =delete;
-    LocalStorage(LocalStorage const&) =delete;
-    LocalStorage& operator=(LocalStorage&&) =delete;
-    LocalStorage& operator=(LocalStorage const&) =delete;
-
-    QVector<BackupInfo> getBackups() override;
-    QSharedPointer<QIODevice> startRestore(const QString& uuid) override;
-    QSharedPointer<QIODevice> startBackup(const BackupInfo& info) override;
-
-private:
-
-    class Impl;
-    friend class Impl;
-    std::unique_ptr<Impl> impl_;
-};
-
-} // namespace internal
-
-} // namespace storage

=== removed file 'src/storage/storage-factory.cpp'
--- src/storage/storage-factory.cpp	2016-05-30 02:16:12 +0000
+++ src/storage/storage-factory.cpp	1970-01-01 00:00:00 +0000
@@ -1,94 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#include <storage/storage-factory.h>
-#include <storage/internal/local-storage.h>
-
-#include <QThread>
-
-#include <QtConcurrent>
-#include <QtDebug>
-
-namespace storage
-{
-
-class StorageFactory::Impl
-{
-public:
-
-    Impl()
-    {
-        const auto modeStr = QString::fromUtf8(qgetenv("KEEPER_BACKEND"));
-
-        if (modeStr.isEmpty())
-            mode_ = DEFAULT_MODE;
-        else if (modeStr == "storage-framework")
-            mode_ = Mode::StorageFramework;
-        else if (modeStr == "memory")
-            mode_ = Mode::Memory;
-        else if (modeStr == "local")
-            mode_ = Mode::Local;
-        else {
-            const auto modeStr8 = modeStr.toUtf8();
-            qFatal("Unrecognized keeper backend: %s", modeStr8.constData());
-        }
-    }
-
-    QFuture<QSharedPointer<Storage>> getStorage()
-    {
-        QFuture<QSharedPointer<Storage>> ret;
-
-        if (mode_ == Mode::Local)
-        {
-            return QtConcurrent::run([](){
-                return QSharedPointer<Storage>{new internal::LocalStorage{}};
-            });
-        }
-
-        qWarning() << "storage not created";
-        return QFuture<QSharedPointer<Storage>>();
-    }
-
-private:
-
-    enum class Mode { StorageFramework, Local, Memory };
-    static constexpr Mode DEFAULT_MODE {Mode::Local}; // while under development
-    Mode mode_ {Mode::Local};
-};
-
-/***
-****
-***/
-
-StorageFactory::StorageFactory():
-    impl_{new Impl{}}
-{
-}
-
-StorageFactory::~StorageFactory()
-{
-}
-
-QFuture<QSharedPointer<Storage>>
-StorageFactory::getStorage()
-{
-    return impl_->getStorage();
-}
-
-} // namespace storage

=== removed file 'src/storage/storage-factory.h'
--- src/storage/storage-factory.h	2016-05-30 02:16:12 +0000
+++ src/storage/storage-factory.h	1970-01-01 00:00:00 +0000
@@ -1,53 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#pragma once
-
-#include "storage/storage.h"
-
-#include <QFuture>
-#include <QSharedPointer>
-
-namespace storage
-{
-
-class StorageFactory
-{
-public:
-
-    StorageFactory();
-    ~StorageFactory();
-
-    StorageFactory(StorageFactory&&) =delete;
-    StorageFactory(StorageFactory const&) =delete;
-    StorageFactory& operator=(StorageFactory&&) =delete;
-    StorageFactory& operator=(StorageFactory const&) =delete;
-
-    // TODO: is factory appropriate for this?
-    QFuture<QSharedPointer<Storage>> getStorage();
-
-private:
-
-    // TODO: use the Qt pimpl macros
-    class Impl;
-    friend class Impl;
-    QSharedPointer<Impl> impl_;
-};
-
-}

=== removed file 'src/storage/storage.cpp'
--- src/storage/storage.cpp	2016-06-20 15:23:27 +0000
+++ src/storage/storage.cpp	1970-01-01 00:00:00 +0000
@@ -1,36 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#include "storage/storage.h"
-
-#include <QtDebug>
-
-namespace storage
-{
-
-Storage::Storage()
-{
-    qDebug() << "hello world";
-}
-
-Storage::~Storage()
-{
-}
-
-} // namespace storage

=== removed file 'src/storage/storage.h'
--- src/storage/storage.h	2016-05-30 02:16:12 +0000
+++ src/storage/storage.h	1970-01-01 00:00:00 +0000
@@ -1,73 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 3, as published
- * by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranties of
- * MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
- *
- * Authors:
- *     Charles Kerr <[e-mail]>
- */
-
-#pragma once
-
-#include <QDateTime>
-#include <QIODevice>
-#include <QSet>
-#include <QSharedPointer>
-#include <QString>
-#include <QVariant>
-#include <QVector>
-
-namespace storage
-{
-
-// NB: this is an experimental class whose API should and will change
-struct BackupInfo
-{
-    QString uuid;
-
-    // TODO: for 1.0 we only need multimedia and everything else; is a packages list needed?
-    QSet<QString> packages;
-    QDateTime timestamp;
-
-    // TODO: this is an escape hatch for if we need to add more properties in the future.
-    // what are the use cases?
-    QVariantMap properties;
-};
-
-// NB: this is an experimental class whose API should and will change
-// TODO: other than these three functions, is there any other functionality to wrap around the storage framework?
-// TODO: these three give Storage too much responsibility, eg startBackup means Storage needs to know how to launch helpers. We want a middleman to decouple them
-class Storage
-{
-public:
-
-    virtual ~Storage();
-
-    Storage(Storage&&) =delete;
-    Storage(Storage const&) =delete;
-    Storage& operator=(Storage&&) =delete;
-    Storage& operator=(Storage const&) =delete;
-
-    virtual QVector<BackupInfo> getBackups() =0;
-
-    virtual QSharedPointer<QIODevice> startRestore(const QString& uuid) =0;
-
-    // TODO: should Storage create the uuid itself?
-    virtual QSharedPointer<QIODevice> startBackup(const BackupInfo& info) =0;
-
-protected:
-
-    Storage();
-};
-
-}