Merge lp:~ken-vandine/content-hub/content_item_move into lp:content-hub

[Ken VanDine]

Added ContentItem.move function to allow pure QML apps to relocate local
files collected.

Added ContentItem.move function to allow pure QML apps to relocate local
files collected.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:119
http://jenkins.qa.ubuntu.com/job/content-hub-ci/171/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-amd64-ci/28
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-armhf-ci/28
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-armhf-ci/28/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-i386-ci/28

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/171/rebuild

review: Approve (continuous-integration)

[Ken VanDine (ken-vandine)]

Are there any related MPs required for this MP to build/function as expected? Please list.

 * No

Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)

 * Yes

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?

 * Yes

Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/content-hub) on device or emulator?

 * Yes

If you changed the UI, was the change specified/approved by design?

 * No change

If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP?

 * No change

[Andrew Hayzen (ahayzen)]

For the music-app, and possibly other apps, we may want to set the filename of the destination as well as the folder. So that we could save a file as ~/Music/Artist/Album/tracknum - title.ext

Therefore I propose the solution of move(dir, name) where dir is a mandatory parameter setting the target directory and name is an optional parameter. If name given it is used as the filename and if is not given the original filename is used.

[Ken VanDine (ken-vandine)]

> For the music-app, and possibly other apps, we may want to set the filename of
> the destination as well as the folder. So that we could save a file as
> ~/Music/Artist/Album/tracknum - title.ext
>
> Therefore I propose the solution of move(dir, name) where dir is a mandatory
> parameter setting the target directory and name is an optional parameter. If
> name given it is used as the filename and if is not given the original
> filename is used.

I that's reasonable, I'll do that.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:121
http://jenkins.qa.ubuntu.com/job/content-hub-ci/172/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-amd64-ci/29
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-armhf-ci/29
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-armhf-ci/29/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-utopic-i386-ci/29

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/172/rebuild

review: Approve (continuous-integration)

[Ken VanDine (ken-vandine)]

You can find an example that exercises the move function at https://code.launchpad.net/~ken-vandine/+junk/hub-importer-with-move

[Andrew Hayzen (ahayzen)]

This meets the requirements specified for the music-app above.

Thanks :)

review: Approve

[Bill Filler (bfiller)]

tested with the sample branch, works as expected

review: Approve

=== modified file 'import/Ubuntu/Content/contentitem.cpp'
--- import/Ubuntu/Content/contentitem.cpp	2014-06-18 13:33:30 +0000
+++ import/Ubuntu/Content/contentitem.cpp	2014-07-10 18:05:11 +0000
@@ -17,7 +17,9 @@
 #include "contentitem.h"
 #include "../../../src/com/ubuntu/content/debug.h"
 #include <QMimeDatabase>
+#include <QDir>
 #include <QFile>
+#include <QFileInfo>
 
 /*!
  * \qmltype ContentItem
@@ -148,3 +150,63 @@
     dataUri.append(QString::fromLatin1(data.toBase64()));
     return QUrl(dataUri);
 }
+
+/*!
+ * \qmlmethod bool ContentItem::move(dir)
+ * \brief If the url is a local file, move the file to \a dir
+ *
+ *  If the move is successful, the url property will be changed
+ *  and onUrlChanged will be emitted.
+ *
+ *  Returns true if the file was moved successfully, false 
+ *  on error or if the url wasn't a local file.
+ */
+bool ContentItem::move(const QString &dir)
+{
+    TRACE() << Q_FUNC_INFO << "dir:" << dir;
+    return (move(dir, nullptr));
+}
+
+/*!
+ * \qmlmethod bool ContentItem::move(dir, fileName)
+ * \brief If the url is a local file, move the file to \a dir and 
+ *  rename to \a fileName
+ *
+ *  If the move is successful, the url property will be changed
+ *  and onUrlChanged will be emitted.
+ *
+ *  Returns true if the file was moved successfully, false 
+ *  on error or if the url wasn't a local file.
+ */
+bool ContentItem::move(const QString &dir, const QString &fileName)
+{
+    TRACE() << Q_FUNC_INFO << "dir:" << dir << "fileName:" << fileName;
+
+    QString path(m_item.url().toLocalFile());
+
+    if (!QFile::exists(path)) {
+        qWarning() << "File not found:" << path;
+        return false;
+    }
+
+    QFileInfo fi(path);
+    QDir d(dir);
+    if (not d.exists())
+        d.mkpath(d.absolutePath());
+
+    QString destFilePath = "";
+    if (fileName.isEmpty())
+        destFilePath = dir + QDir::separator() + fi.fileName();
+    else
+        destFilePath = dir + QDir::separator() + fileName;
+
+    TRACE() << Q_FUNC_INFO << "New path:" << destFilePath;
+
+    if (not QFile::rename(fi.absoluteFilePath(), destFilePath)) {
+        qWarning() << "Failed to move content to:" << destFilePath;
+        return false;
+    }
+
+    setUrl(QUrl::fromLocalFile(destFilePath));
+    return true;
+}

=== modified file 'import/Ubuntu/Content/contentitem.h'
--- import/Ubuntu/Content/contentitem.h	2014-05-23 09:55:11 +0000
+++ import/Ubuntu/Content/contentitem.h	2014-07-10 18:05:11 +0000
@@ -42,6 +42,8 @@
     void setItem(const com::ubuntu::content::Item &item);
 
     Q_INVOKABLE QUrl toDataURI();
+    Q_INVOKABLE bool move(const QString &dir);
+    Q_INVOKABLE bool move(const QString &dir, const QString &fileName);
 
 Q_SIGNALS:
     void nameChanged();