# HG changeset patch
# User Chris Cannam
# Date 1225108415 0
# Node ID 63b8ba45d9531abdb723093fcd7d0b2137474f65
# Parent  9525c9d7e54d48c3fa5b7dad407ad951a38ee509
* stub out persistent cacheing class, as I've decided I don't like the
  way things were going with trying to incorporate all this logic into
  the already too big FileSource class

diff -r 9525c9d7e54d -r 63b8ba45d953 data/data.pro
--- a/data/data.pro	Fri Oct 24 14:52:40 2008 +0000
+++ b/data/data.pro	Mon Oct 27 11:53:35 2008 +0000
@@ -23,6 +23,7 @@
            fileio/AudioFileReader.h \
            fileio/AudioFileReaderFactory.h \
            fileio/BZipFileDevice.h \
+           fileio/CachedFile.h \
            fileio/CodedAudioFileReader.h \
            fileio/CSVFileReader.h \
            fileio/CSVFileWriter.h \
@@ -77,6 +78,7 @@
            fileio/AudioFileReader.cpp \
            fileio/AudioFileReaderFactory.cpp \
            fileio/BZipFileDevice.cpp \
+           fileio/CachedFile.cpp \
            fileio/CodedAudioFileReader.cpp \
            fileio/CSVFileReader.cpp \
            fileio/CSVFileWriter.cpp \
diff -r 9525c9d7e54d -r 63b8ba45d953 data/fileio/CachedFile.cpp
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data/fileio/CachedFile.cpp	Mon Oct 27 11:53:35 2008 +0000
@@ -0,0 +1,174 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2008 QMUL.
+    
+    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; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#include "CachedFile.h"
+
+#include "base/TempDirectory.h"
+#include "base/ProgressReporter.h"
+#include "base/Exceptions.h"
+
+#include <QFileInfo>
+#include <QSettings>
+#include <QVariant>
+#include <QMap>
+#include <QDir>
+#include <QCryptographicHash>
+
+QString
+CachedFile::getLocalFilenameFor(QUrl url)
+{
+    QDir dir(getCacheDirectory());
+
+    QString filename =
+        QString::fromLocal8Bit
+        (QCryptographicHash::hash(url.toString().toLocal8Bit(),
+                                  QCryptographicHash::Sha1).toHex());
+
+    return dir.filePath(filename);
+}
+
+QString
+CachedFile::getCacheDirectory()
+{
+    QDir dir = TempDirectory::getInstance()->getContainingPath();
+
+    QString cacheDirName("cache");
+
+    QFileInfo fi(dir.filePath(cacheDirName));
+
+    if ((fi.exists() && !fi.isDir()) ||
+        (!fi.exists() && !dir.mkdir(cacheDirName))) {
+
+        throw DirectoryCreationFailed(fi.filePath());
+    }
+
+    return fi.filePath();
+}
+
+CachedFile::CachedFile(QUrl url, ProgressReporter *reporter) :
+    m_url(url),
+    m_localFilename(getLocalFilenameFor(url)),
+    m_ok(false)
+{
+    refresh();
+}
+
+bool
+CachedFile::isOK() const
+{
+    return m_ok;
+}
+
+QString
+CachedFile::getLocalFilename() const
+{
+    return m_localFilename;
+}
+
+void
+CachedFile::refresh()
+{
+    //!!! n.b. obvious race condition here if different CachedFile
+    // objects for same url used in more than one thread -- need to
+    // lock appropriately.  also consider race condition between
+    // separate instances of the program
+
+    if (!QFileInfo(m_localFilename).exists()) {
+        updateLastRetrieval(false); // empirically!
+    }
+
+    QDateTime lastRetrieval = getLastRetrieval();
+
+    if (lastRetrieval.isValid()) {
+        // this will not be the case if the file is missing, after
+        // updateLastRetrieval(false) was called above
+        m_ok = true;
+        if (lastRetrieval.addDays(2) < QDateTime::currentDateTime()) { //!!!
+            // doesn't matter if retrieval fails -- we just don't
+            // update the last retrieval time
+
+            //!!! but we do want an additional last-attempted
+            // timestamp so as to ensure we aren't retrying the
+            // retrieval every single time if it isn't working
+
+            if (retrieve()) {
+                updateLastRetrieval(true);
+            }
+        }
+    } else {
+        // there is no acceptable file
+        if (retrieve()) {
+            m_ok = true;
+            updateLastRetrieval(true);
+        } else {
+            // again, we don't need to do anything here -- the last
+            // retrieval timestamp is already invalid
+        }
+    }
+}
+
+bool
+CachedFile::retrieve()
+{
+    //!!! need to work by retrieving the file to another name, and
+    //!!! then "atomically" moving it to its proper place (I'm not
+    //!!! sure we can do an atomic move to replace an existing file
+    //!!! using Qt classes, but a plain delete then copy is probably
+    //!!! good enough)
+
+
+
+
+}
+
+QDateTime
+CachedFile::getLastRetrieval()
+{
+    QSettings settings;
+    settings.beginGroup("FileCache");
+
+    QString key("last-retrieval-times");
+
+    QMap<QString, QVariant> timeMap = settings.value(key).toMap();
+    QDateTime lastTime = timeMap[m_localFilename].toDateTime();
+
+    settings.endGroup();
+    return lastTime;
+}
+
+void
+CachedFile::updateLastRetrieval(bool successful)
+{
+    //!!! note !successful does not mean "we failed to update the
+    //!!! file" (and so it remains the same as before); it means "the
+    //!!! file is not there at all"
+    
+    QSettings settings;
+    settings.beginGroup("FileCache");
+
+    QString key("last-retrieval-times");
+
+    QMap<QString, QVariant> timeMap = settings.value(key).toMap();
+
+    QDateTime dt;
+    if (successful) dt = QDateTime::currentDateTime();
+
+    timeMap[m_localFilename] = dt;
+    settings.setValue(key, timeMap);
+
+    settings.endGroup();
+}
+
+
diff -r 9525c9d7e54d -r 63b8ba45d953 data/fileio/CachedFile.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data/fileio/CachedFile.h	Mon Oct 27 11:53:35 2008 +0000
@@ -0,0 +1,51 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2008 QMUL.
+    
+    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; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#ifndef _CACHED_FILE_H_
+#define _CACHED_FILE_H_
+
+#include <QString>
+#include <QUrl>
+#include <QDateTime>
+
+class ProgressReporter;
+
+class CachedFile
+{
+public:
+    CachedFile(QUrl url, ProgressReporter *reporter = 0);
+
+    virtual ~CachedFile();
+
+    bool isOK() const;
+
+    QString getLocalFilename() const;
+
+protected:
+    QUrl m_url;
+    QString m_localFilename;
+    bool m_ok;
+
+    void refresh();
+    bool retrieve();
+
+    QDateTime getLastRetrieval();
+    void updateLastRetrieval(bool successful);
+
+    static QString getCacheDirectory();
+    static QString getLocalFilenameFor(QUrl url);
+};
+
+#endif
diff -r 9525c9d7e54d -r 63b8ba45d953 data/fileio/FileSource.h
--- a/data/fileio/FileSource.h	Fri Oct 24 14:52:40 2008 +0000
+++ b/data/fileio/FileSource.h	Mon Oct 27 11:53:35 2008 +0000
@@ -13,8 +13,8 @@
     COPYING included with this distribution for more information.
 */
 
-#ifndef _REMOTE_FILE_H_
-#define _REMOTE_FILE_H_
+#ifndef _FILE_SOURCE_H_
+#define _FILE_SOURCE_H_
 
 #include <QUrl>
 #include <QMutex>