kworship/KwDocument.cpp

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 /**
  21  * @file KwDocument.cpp
  22  * @brief A KWorship document (anything saved in a KWorship data file).
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwDocument.h"
  27 #include "KwArchive.h"
  28 #include "KwPlaylistList.h"
  29
  30 #include <KSaveFile>
  31 #include <KLocale>
  32 #include <KMessageBox>
  33
  34 /*
  35  * Constructors + destructor
  36  */
  37
  38 /// Primary constructor.
  39 KwDocument::KwDocument(KUrl url, QObject* parent)
  40 : QObject(parent)
  41 , m_url(url)
  42 , m_modified(false)
  43 , m_playlist(new KwPlaylistList())
  44 {
  45 }
  46
  47 /// Destructor.
  48 KwDocument::~KwDocument()
  49 {
  50   delete m_playlist;
  51 }
  52
  53 /*
  54  * Accessors
  55  */
  56
  57 /// Find whether the document has been modified.
  58 bool KwDocument::isModified() const
  59 {
  60   return m_modified;
  61 }
  62
  63 /// Find whether the document has ever been saved.
  64 bool KwDocument::isSaved() const
  65 {
  66   return !m_url.isEmpty();
  67 }
  68
  69 /// Get the URL the document is saved at.
  70 KUrl KwDocument::url() const
  71 {
  72   return m_url;
  73 }
  74
  75 /// Get the main playlist.
  76 KwPlaylistList* KwDocument::playlist()
  77 {
  78   return m_playlist;
  79 }
  80
  81 /*
  82  * Saving and loading actions
  83  */
  84
  85 /// Load the file.
  86 void KwDocument::reload()
  87 {
  88   // Start off by opening the archive file
  89   if (!m_url.isLocalFile())
  90   {
  91     KMessageBox::error(0,
  92         i18n("Non-local loads not yet supported"),
  93         i18n("KWorship"));
  94     return;
  95   }
  96
  97   // Create a new archive object and fill it
  98   KwArchive* archive = new KwArchive(m_url.toLocalFile(), false);
  99   loadFromArchive(archive);
 100   delete archive;
 101
 102   setModified(false);
 103 }
 104
 105 /// Save the file.
 106 void KwDocument::save()
 107 {
 108   Q_ASSERT(isSaved());
 109
 110   // Start off by opening the archive file
 111   if (!m_url.isLocalFile())
 112   {
 113     KMessageBox::error(0,
 114         i18n("Non-local saves not yet supported"),
 115         i18n("KWorship"));
 116     return;
 117   }
 118   KSaveFile file;
 119   file.setFileName(m_url.toLocalFile());
 120   if (!file.open(QFile::WriteOnly))
 121   {
 122     KMessageBox::error(0,
 123         i18n("Cannot write file %1:\n%2.")
 124           .arg(file.fileName())
 125           .arg(file.errorString()),
 126         i18n("KWorship"));
 127     return;
 128   }
 129
 130   // Create a new archive object and fill it
 131   KwArchive* archive = new KwArchive(&file, true);
 132   saveToArchive(archive);
 133   delete archive;
 134
 135   if (!file.finalize())
 136   {
 137     KMessageBox::error(0,
 138         i18n("Cannot finalize file %1:\n%2.")
 139           .arg(file.fileName())
 140           .arg(file.errorString()),
 141         i18n("KWorship"));
 142     return;
 143   }
 144
 145   setModified(false);
 146 }
 147
 148 /// Save the file to a different URL.
 149 void KwDocument::saveAs(const KUrl& url)
 150 {
 151   m_url = url;
 152   save();
 153 }
 154
 155 /*
 156  * Other slots
 157  */
 158
 159 /// Set whether the file is modified.
 160 void KwDocument::setModified(bool modified)
 161 {
 162   if (m_modified != modified)
 163   {
 164     m_modified = modified;
 165     modifiedChanged(modified);
 166   }
 167 }
 168
 169 /*
 170  * Archive interface.
 171  */
 172
 173 /// Load from an archive.
 174 void KwDocument::loadFromArchive(KwArchive* archive)
 175 {
 176   Q_ASSERT(archive->isReading());
 177
 178   KwPlaylistList* playlist = archive->extractPlaylist("0");
 179   if (0 != playlist)
 180   {
 181     delete m_playlist;
 182     m_playlist = playlist;
 183     playlistReset();
 184   }
 185 }
 186
 187 /// Save to an archive.
 188 void KwDocument::saveToArchive(KwArchive* archive) const
 189 {
 190   Q_ASSERT(archive->isWriting());
 191
 192   archive->addPlaylist(m_playlist);
 193 }
 194