Add UI to auto-update and save/restore state

src/LoadXSPFDialog.ui

@@ -19,7 +19,7 @@
      <item>
       <widget class="QLabel" name="label">
        <property name="text">
-        <string>XSPF Url:</string>
+        <string>Playlist Url</string>
        </property>
       </widget>
      </item>

src/libtomahawk/CMakeLists.txt

@@ -140,6 +140,7 @@ set( libSources
     playlist/artistview.cpp
     playlist/customplaylistview.cpp
     playlist/ViewHeader.cpp
+    playlist/PlaylistUpdaterInterface.cpp
     playlist/XspfUpdater.cpp
 
     playlist/topbar/topbar.cpp

src/libtomahawk/collection.cpp

@@ -24,6 +24,7 @@
 #include "source.h"
 
 #include "utils/logger.h"
+#include <PlaylistUpdaterInterface.h>
 
 using namespace Tomahawk;
 
@@ -185,6 +186,8 @@ Collection::setPlaylists( const QList<Tomahawk::playlist_ptr>& plists )
     {
 //        qDebug() << "Batch inserting playlist:" << p->guid();
         m_playlists.insert( p->guid(), p );
+        if ( !m_source.isNull() && m_source->isLocal() )
+            PlaylistUpdaterInterface::loadForPlaylist( p );
     }
     emit playlistsAdded( plists );
 }

src/libtomahawk/infobar/infobar.cpp

@@ -26,6 +26,7 @@
 #include "thirdparty/Qocoa/qsearchfield.h"
 #include "utils/tomahawkutils.h"
 #include "utils/logger.h"
+#include <QCheckBox>
 
 #define ANIMATION_TIME 400
 #define IMAGE_HEIGHT 64
@@ -70,6 +71,14 @@ InfoBar::InfoBar( QWidget* parent )
     ui->longDescriptionLabel->setText( QString() );
     ui->imageLabel->setText( QString() );
 
+    m_autoUpdate = new QCheckBox( this );
+    m_autoUpdate->setText( tr( "Automatically update" ) );
+    m_autoUpdate->setLayoutDirection( Qt::RightToLeft );
+    m_autoUpdate->setPalette( whitePal );
+    connect( m_autoUpdate, SIGNAL( stateChanged( int ) ), this, SIGNAL( autoUpdateChanged( int ) ) );
+
+    ui->horizontalLayout->addWidget( m_autoUpdate );
+
     m_searchWidget = new QSearchField( this );
     m_searchWidget->setPlaceholderText( tr( "Filter..." ) );
     m_searchWidget->setMinimumWidth( 180 );
@@ -87,6 +96,7 @@ InfoBar::InfoBar( QWidget* parent )
     setAutoFillBackground( true );
 
     connect( ViewManager::instance(), SIGNAL( filterAvailable( bool ) ), SLOT( setFilterAvailable( bool ) ) );
+    connect( ViewManager::instance(), SIGNAL( autoUpdateAvailable( bool ) ), SLOT( setAutoUpdateAvailable( bool ) ) );
 }
 
 
@@ -147,6 +157,15 @@ InfoBar::setFilterAvailable( bool b )
     m_searchWidget->setVisible( b );
 }
 
+void
+InfoBar::setAutoUpdateAvailable( bool b )
+{
+    if ( b )
+        m_autoUpdate->setChecked( ViewManager::instance()->currentPage()->autoUpdate() );
+
+    m_autoUpdate->setVisible( b );
+}
+
 
 void
 InfoBar::onFilterEdited()
@@ -154,7 +173,6 @@ InfoBar::onFilterEdited()
     emit filterTextChanged( m_searchWidget->text() );
 }
 
-
 void
 InfoBar::changeEvent( QEvent* e )
 {

src/libtomahawk/infobar/infobar.h

@@ -23,6 +23,7 @@
 
 #include "dllmacro.h"
 
+class QCheckBox;
 class QTimeLine;
 class QSearchField;
 class ContextWidget;
@@ -49,8 +50,10 @@ public slots:
     void setFilter( const QString& filter );
     void setFilterAvailable( bool b );
 
+    void setAutoUpdateAvailable( bool b );
 signals:
     void filterTextChanged( const QString& filter );
+    void autoUpdateChanged( int state );
 
 protected:
     void changeEvent( QEvent* e );
@@ -62,6 +65,7 @@ private:
     Ui::InfoBar* ui;
 
     QSearchField* m_searchWidget;
+    QCheckBox* m_autoUpdate;
 };
 
 #endif // INFOBAR_H

src/libtomahawk/playlist.h

@@ -198,7 +198,7 @@ public:
     virtual void setFilter( const QString& /*pattern*/ ) {}
 
     QList<plentry_ptr> entriesFromQueries( const QList<Tomahawk::query_ptr>& queries, bool clearFirst = false );
-    void setUpdater( PlaylistUpdaterInterface* interface ) const { m_updater = interface; }
+    void setUpdater( PlaylistUpdaterInterface* interface ) { m_updater = interface; }
     PlaylistUpdaterInterface* updater() const { return m_updater; }
 
 signals:

src/libtomahawk/playlist/PlaylistUpdaterInterface.cpp

@@ -0,0 +1,104 @@
+/* === This file is part of Tomahawk Player - <http://tomahawk-player.org> ===
+ *
+ *   Copyright 2010-2011, Leo Franchi <lfranchi@kde.org>
+ *
+ *   Tomahawk 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, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Tomahawk 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 Tomahawk. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "PlaylistUpdaterInterface.h"
+#include "tomahawksettings.h"
+#include "XspfUpdater.h"
+
+using namespace Tomahawk;
+
+PlaylistUpdaterInterface*
+PlaylistUpdaterInterface::loadForPlaylist( const playlist_ptr& pl )
+{
+    TomahawkSettings* s = TomahawkSettings::instance();
+    const QString key = QString( "playlistupdaters/%1" ).arg( pl->guid() );
+    if ( s->contains( QString( "%1/type" ).arg( key ) ) )
+    {
+        // Ok, we have one we can try to load
+        const QString type = s->value( QString( "%1/type" ).arg( key ) ).toString();
+        PlaylistUpdaterInterface* updater = 0;
+        if ( type == "xspf" )
+            updater = new XspfUpdater( pl );
+
+        // You forgot to register your new updater type with the factory above. 00ps.
+        if ( !updater )
+        {
+            Q_ASSERT( false );
+            return 0;
+        }
+        updater->setAutoUpdate( s->value( QString( "%1/autoupdate" ).arg( key ) ).toBool() );
+        updater->setInterval( s->value( QString( "%1/interval" ).arg( key ) ).toInt() );
+        updater->loadFromSettings( key );
+
+        return updater;
+    }
+
+    return 0;
+}
+
+
+PlaylistUpdaterInterface::PlaylistUpdaterInterface( const playlist_ptr& pl )
+    : QObject( 0 )
+    , m_timer( new QTimer( this ) )
+    , m_autoUpdate( true )
+    , m_playlist( pl )
+{
+    Q_ASSERT( !m_playlist.isNull() );
+
+    m_playlist->setUpdater( this );
+    connect( m_timer, SIGNAL( timeout() ), this, SLOT( updateNow() ) );
+
+    QTimer::singleShot( 0, this, SLOT( doSave() ) );
+}
+
+void
+PlaylistUpdaterInterface::doSave()
+{
+    TomahawkSettings* s = TomahawkSettings::instance();
+    const QString key = QString( "playlistupdaters/%1" ).arg( m_playlist->guid() );
+    if ( !s->contains( QString( "%1/type" ).arg( key ) ) )
+    {
+        s->setValue( QString( "%1/type" ).arg( key ), type() );
+        s->setValue( QString( "%1/autoupdate" ).arg( key ), m_autoUpdate );
+        s->setValue( QString( "%1/interval" ).arg( key ), m_timer->interval() );
+        saveToSettings( key );
+    }
+}
+
+void
+PlaylistUpdaterInterface::setAutoUpdate( bool autoUpdate )
+{
+    m_autoUpdate = autoUpdate;
+    if ( m_autoUpdate )
+        m_timer->start();
+    else
+        m_timer->stop();
+
+    const QString key = QString( "playlistupdaters/%1/autoupdate" ).arg( m_playlist->guid() );
+    TomahawkSettings::instance()->setValue( key, m_autoUpdate );
+}
+
+void
+PlaylistUpdaterInterface::setInterval( int intervalMsecs )
+{
+    const QString key = QString( "playlistupdaters/%1/interval" ).arg( m_playlist->guid() );
+    TomahawkSettings::instance()->setValue( key, intervalMsecs );
+
+    m_timer->setInterval( intervalMsecs );
+}
+

src/libtomahawk/playlist/PlaylistUpdaterInterface.h

@@ -36,38 +36,35 @@ class DLLEXPORT PlaylistUpdaterInterface : public QObject
 {
     Q_OBJECT
 public:
-    PlaylistUpdaterInterface( const playlist_ptr& pl )
+    PlaylistUpdaterInterface( const playlist_ptr& pl );
-        : QObject( pl.data() )
-        , m_timer( new QTimer( this ) )
-        , m_autoUpdate( true )
-        , m_playlist( pl )
-    {
-        Q_ASSERT( !m_playlist.isNull() );
-
-        m_playlist->setUpdater( this );
-        connect( m_timer, SIGNAL( timeout() ), this, SLOT( updateNow() ) );
-    }
 
     virtual ~PlaylistUpdaterInterface(){}
 
-    void setAutoUpdate( bool autoUpdate ) {
+    // What type you are. If you add a new updater, add the creation code as well.
-        m_autoUpdate = autoUpdate;
+    virtual QString type() const = 0;
-        if ( m_autoUpdate )
-            m_timer->start();
-        else
-            m_timer->stop();
-    }
 
     bool autoUpdate() const { return m_autoUpdate; }
+    void setAutoUpdate( bool autoUpdate );
 
-    void setInterval( int intervalMsecs ) { m_timer->setInterval( intervalMsecs ); }
+    void setInterval( int intervalMsecs ) ;
     int intervalMsecs() const { return m_timer->interval(); }
 
     playlist_ptr playlist() const { return m_playlist; }
 
+    /// If you want to try to load a updater from the settings. Returns a valid
+    /// updater if one was saved
+    static PlaylistUpdaterInterface* loadForPlaylist( const playlist_ptr& pl );
+
 public slots:
     virtual void updateNow() {}
 
+private slots:
+    void doSave();
+
+protected:
+    virtual void loadFromSettings( const QString& group ) = 0;
+    virtual void saveToSettings( const QString& group ) const = 0;
+
 private:
     QTimer* m_timer;
     bool m_autoUpdate;

src/libtomahawk/playlist/XspfUpdater.cpp

@@ -22,6 +22,7 @@
 #include "utils/xspfloader.h"
 
 #include <QTimer>
+#include <tomahawksettings.h>
 
 using namespace Tomahawk;
 
@@ -31,6 +32,13 @@ XspfUpdater::XspfUpdater( const playlist_ptr& pl, const QString& xUrl )
 {
 }
 
+XspfUpdater::XspfUpdater( const playlist_ptr& pl )
+    : PlaylistUpdaterInterface( pl )
+{
+
+}
+
+
 XspfUpdater::~XspfUpdater()
 {}
 
@@ -62,3 +70,15 @@ XspfUpdater::playlistLoaded()
 //        }
 //    }
 }
+
+void
+XspfUpdater::saveToSettings( const QString& group ) const
+{
+    TomahawkSettings::instance()->setValue( QString( "%1/xspfurl" ).arg( group ), m_url );
+}
+
+void
+XspfUpdater::loadFromSettings( const QString& group )
+{
+    m_url = TomahawkSettings::instance()->value( QString( "%1/xspfurl" ).arg( group ) ).toString();
+}

src/libtomahawk/playlist/XspfUpdater.h

@@ -30,12 +30,19 @@ class XspfUpdater : public PlaylistUpdaterInterface
 {
     Q_OBJECT
 public:
-    explicit XspfUpdater( const playlist_ptr& pl, const QString& xspfUrl );
+    XspfUpdater( const playlist_ptr& pl, const QString& xspfUrl );
+    explicit XspfUpdater( const playlist_ptr& pl ); // used by factory
+
     virtual ~XspfUpdater();
 
+    virtual QString type() const { return "xspf"; }
 public slots:
     void updateNow();
 
+protected:
+    void loadFromSettings( const QString& group );
+    void saveToSettings( const QString& group ) const;
+
 private slots:
     void playlistLoaded();
 

src/libtomahawk/playlist/playlistview.cpp

@@ -25,6 +25,7 @@
 #include "widgets/overlaywidget.h"
 #include "viewmanager.h"
 #include "utils/logger.h"
+#include "PlaylistUpdaterInterface.h"
 
 using namespace Tomahawk;
 
@@ -104,6 +105,34 @@ PlaylistView::deleteItems()
     proxyModel()->removeIndexes( selectedIndexes() );
 }
 
+bool
+PlaylistView::canAutoUpdate() const
+{
+    if ( !m_model->playlist().isNull() && m_model->playlist()->updater() )
+        return true;
+
+    return false;
+}
+
+bool
+PlaylistView::autoUpdate() const
+{
+    if ( canAutoUpdate() )
+        return m_model->playlist()->updater()->autoUpdate();
+
+    return false;
+}
+
+
+void
+PlaylistView::setAutoUpdate( bool autoUpdate )
+{
+    if ( !canAutoUpdate() )
+        return;
+
+    m_model->playlist()->updater()->setAutoUpdate( autoUpdate );
+}
+
 
 void
 PlaylistView::onTrackCountChanged( unsigned int tracks )

src/libtomahawk/playlist/playlistview.h

@@ -42,6 +42,10 @@ public:
 
     virtual bool showFilter() const { return true; }
 
+    virtual bool canAutoUpdate() const;
+    virtual void setAutoUpdate( bool autoUpdate );
+    virtual bool autoUpdate() const;
+
     virtual QString title() const { return playlistModel()->title(); }
     virtual QString description() const { return m_model->description(); }
     virtual QPixmap pixmap() const { return QPixmap( RESPATH "images/playlist-icon.png" ); }

src/libtomahawk/utils/xspfloader.cpp

@@ -222,12 +222,9 @@ XSPFLoader::gotBody()
                                        false,
                                        m_entries );
 
-        if ( m_autoUpdate )
-        {
         Tomahawk::XspfUpdater* updater = new Tomahawk::XspfUpdater( m_playlist, m_url.toString() );
         updater->setInterval( 60000 );
-            updater->setAutoUpdate( true );
+        updater->setAutoUpdate( m_autoUpdate );
-        }
         deleteLater();
     }
 

src/libtomahawk/viewmanager.cpp

@@ -109,6 +109,7 @@ ViewManager::ViewManager( QObject* parent )
 
     connect( &m_filterTimer, SIGNAL( timeout() ), SLOT( applyFilter() ) );
     connect( m_infobar, SIGNAL( filterTextChanged( QString ) ), SLOT( setFilter( QString ) ) );
+    connect( m_infobar, SIGNAL( autoUpdateChanged( int ) ), SLOT( autoUpdateChanged( int ) ) );
 /*    connect( m_infobar, SIGNAL( flatMode() ), SLOT( setTableMode() ) );
     connect( m_infobar, SIGNAL( artistMode() ), SLOT( setTreeMode() ) );
     connect( m_infobar, SIGNAL( albumMode() ), SLOT( setAlbumMode() ) );*/
@@ -506,6 +507,13 @@ ViewManager::applyFilter()
 }
 
 
+void
+ViewManager::autoUpdateChanged( int state )
+{
+    currentPage()->setAutoUpdate( state == Qt::Checked );
+}
+
+
 void
 ViewManager::setPage( ViewPage* page, bool trackHistory )
 {
@@ -656,6 +664,8 @@ ViewManager::updateView()
     emit modesAvailable( currentPage()->showModes() );
     emit filterAvailable( currentPage()->showFilter() );
 
+    emit autoUpdateAvailable( currentPage()->canAutoUpdate() );
+
 /*    if ( !currentPage()->showStatsBar() && !currentPage()->showModes() && !currentPage()->showFilter() )
         m_topbar->setVisible( false );
     else

src/libtomahawk/viewmanager.h

@@ -117,6 +117,7 @@ signals:
     void statsAvailable( bool b );
     void modesAvailable( bool b );
     void filterAvailable( bool b );
+    void autoUpdateAvailable( bool b );
     void modeChanged( Tomahawk::PlaylistInterface::ViewMode mode );
 
     void playClicked();
@@ -165,6 +166,8 @@ private slots:
     void setFilter( const QString& filter );
     void applyFilter();
 
+    void autoUpdateChanged( int );
+
     void onWidgetDestroyed( QWidget* widget );
 
 private:

src/libtomahawk/viewpage.h

@@ -54,6 +54,10 @@ public:
 
     virtual bool isTemporaryPage() const { return false; }
 
+    virtual bool canAutoUpdate() const { return false; }
+    virtual void setAutoUpdate( bool ) {}
+    virtual bool autoUpdate() const { return false; }
+
     /** subclasses implementing ViewPage can emit the following signals:
      * nameChanged( const QString& )
      * descriptionChanged( const QString& )
@@ -63,7 +67,6 @@ public:
      *
      * See DynamicWidget for an example
      */
-private:
 };
 
 }; // ns