FsDiscoverer.cpp 9.28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*****************************************************************************
 * Media Library
 *****************************************************************************
 * Copyright (C) 2015 Hugo Beauzée-Luyssen, Videolabs
 *
 * Authors: Hugo Beauzée-Luyssen<hugo@beauzee.fr>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

23 24
#include "FsDiscoverer.h"

25
#include <algorithm>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
26 27
#include <queue>

28
#include "factory/FileSystem.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
29
#include "filesystem/IDevice.h"
30
#include "Media.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
31
#include "Device.h"
32
#include "Folder.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
33
#include "logging/Logger.h"
34
#include "MediaLibrary.h"
35

36
FsDiscoverer::FsDiscoverer( std::shared_ptr<factory::IFileSystem> fsFactory, MediaLibrary* ml, DBConnection dbConn )
37 38
    : m_ml( ml )
    , m_dbConn( dbConn )
39 40 41 42
{
    if ( fsFactory != nullptr )
        m_fsFactory = fsFactory;
    else
43
        m_fsFactory.reset( new factory::FileSystemFactory );
44 45
}

46
bool FsDiscoverer::discover( const std::string &entryPoint )
47
{
48 49 50
    // Assume :// denotes a scheme that isn't a file path, and refuse to discover it.
    if ( entryPoint.find( "://" ) != std::string::npos )
        return false;
51 52

    {
53
        auto f = Folder::fromPath( m_dbConn, entryPoint );
54
        // If the folder exists, we assume it will be handled by reload()
55 56 57 58
        if ( f != nullptr )
            return true;
    }
    // Otherwise, create a directory, and check it for modifications
59
    std::shared_ptr<fs::IDirectory> fsDir;
60 61 62 63 64 65 66 67 68
    try
    {
        fsDir = m_fsFactory->createDirectory( entryPoint );
    }
    catch (std::exception& ex)
    {
        LOG_ERROR("Failed to create an IDirectory for ", entryPoint, ": ", ex.what());
        return false;
    }
69
    auto blist = blacklist();
70
    if ( isBlacklisted( fsDir->path(), blist ) == true )
71
        return false;
72
    return addFolder( fsDir.get(), nullptr, blist );
73 74
}

75
void FsDiscoverer::reload()
76 77 78 79
{
    //FIXME: This should probably be in a sql transaction
    static const std::string req = "SELECT * FROM " + policy::FolderTable::Name
            + " WHERE id_parent IS NULL";
80
    auto rootFolders = Folder::fetchAll<Folder>( m_dbConn, req );
81
    auto blist = blacklist();
82
    for ( const auto& f : rootFolders )
83
    {
84
        auto folder = m_fsFactory->createDirectory( f->path() );
85 86 87 88 89 90 91 92 93
        // Don't assume a folder that is a mountpoint will get its modification date updated on all platforms
        // So first, we check if the device containing this folder is available:
        auto deviceFs = folder->device();
        if ( deviceFs == nullptr )
        {
            auto device = Device::fetch( m_dbConn, f->deviceId() );
            device->setPresent( false );
            continue;
        }
94 95
        checkSubfolders( folder.get(), f.get(), blist );
        checkFiles( folder.get(), f.get() );
96
        f->setLastModificationDate( folder->lastModificationDate() );
97 98 99
    }
}

100
bool FsDiscoverer::checkSubfolders( fs::IDirectory* folder, Folder* parentFolder, const std::vector<std::shared_ptr<Folder>> blacklist ) const
101 102 103 104 105 106 107 108
{
    // From here we can have:
    // - New subfolder(s)
    // - Deleted subfolder(s)
    // - New file(s)
    // - Deleted file(s)
    // - Changed file(s)
    // ... in this folder, or in all the sub folders.
109

110 111 112
    // Load the folders we already know of:
    static const std::string req = "SELECT * FROM " + policy::FolderTable::Name
            + " WHERE id_parent = ?";
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
113
    LOG_INFO( "Checking for modifications in ", folder->path() );
114
    auto subFoldersInDB = Folder::fetchAll<Folder>( m_dbConn, req, parentFolder->id() );
115 116
    for ( const auto& subFolderPath : folder->dirs() )
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
117 118
        auto subFolder = m_fsFactory->createDirectory( subFolderPath );

119 120 121 122 123
        auto it = std::find_if( begin( subFoldersInDB ), end( subFoldersInDB ), [subFolderPath](const std::shared_ptr<IFolder>& f) {
            return f->path() == subFolderPath;
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
124
        {
125
            // Check if it is blacklisted
126
            if ( isBlacklisted( subFolderPath, blacklist ) == true )
127 128 129 130
            {
                LOG_INFO( "Ignoring blacklisted folder: ", subFolderPath );
                continue;
            }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
131
            LOG_INFO( "New folder detected: ", subFolderPath );
132
            addFolder( subFolder.get(), parentFolder, blacklist );
133
            continue;
134
        }
135
        auto folderInDb = *it;
136 137
        auto deviceFs = subFolder->device();
        // If the device supposed to contain this folder is not present anymore, flag it as removed
138
        if ( deviceFs == nullptr || deviceFs->isPresent() == false )
139
        {
140 141 142 143 144 145 146 147 148
            auto device = Device::fetch( m_dbConn, folderInDb->deviceId() );
            if ( device == nullptr )
            {
                LOG_ERROR( "Failed to fetch device containing folder ", folderInDb->path() );
                continue;
            }
            LOG_INFO( "Device containing ", folderInDb->path(), " is not present anymore" );
            device->setPresent( false );
            // Don't let this folder be deleted after the main loop.
149
            subFoldersInDB.erase( it );
150 151
            continue;
        }
152 153 154
        // In any case, check for modifications, as a change related to a mountpoint might
        // not update the folder modification date.
        // Also, relying on the modification date probably isn't portable
155 156
        checkSubfolders( subFolder.get(), folderInDb.get(), blacklist );
        checkFiles( subFolder.get(), folderInDb.get() );
157
        folderInDb->setLastModificationDate( subFolder->lastModificationDate() );
158 159 160 161 162
        subFoldersInDB.erase( it );
    }
    // Now all folders we had in DB but haven't seen from the FS must have been deleted.
    for ( auto f : subFoldersInDB )
    {
163 164
        LOG_INFO( "Folder ", f->path(), " not found in FS, deleting it" );
        m_ml->deleteFolder( f );
165 166 167
    }
    return true;
}
168

169
void FsDiscoverer::checkFiles( fs::IDirectory* folder, Folder* parentFolder ) const
170
{
171
    LOG_INFO( "Checking file in ", folder->path() );
172
    static const std::string req = "SELECT * FROM " + policy::MediaTable::Name
173
            + " WHERE folder_id = ?";
174
    auto files = Media::fetchAll<Media>( m_dbConn, req, parentFolder->id() );
175 176
    for ( const auto& filePath : folder->files() )
    {        
177
        auto it = std::find_if( begin( files ), end( files ), [filePath](const std::shared_ptr<IMedia>& f) {
178 179 180 181
            return f->mrl() == filePath;
        });
        if ( it == end( files ) )
        {
182
            m_ml->addFile( filePath, parentFolder );
183
            continue;
184 185
        }
        auto file = m_fsFactory->createFile( filePath );
186
        if ( file->lastModificationDate() == (*it)->lastModificationDate() )
187
        {
188 189 190
            // Unchanged file
            files.erase( it );
            continue;
191
        }
192
        LOG_INFO( "Forcing file refresh ", filePath );
193
        m_ml->deleteFile( (*it).get() );
194
        m_ml->addFile( filePath, parentFolder );
195 196 197 198
        files.erase( it );
    }
    for ( auto file : files )
    {
199
        LOG_INFO( "File ", file->mrl(), " not found on filesystem, deleting it" );
200
        m_ml->deleteFile( file.get() );
201 202
    }
}
203 204 205 206 207 208

std::vector<std::shared_ptr<Folder> > FsDiscoverer::blacklist() const
{
    static const std::string req = "SELECT * FROM " + policy::FolderTable::Name + " WHERE is_blacklisted = 1";
    return sqlite::Tools::fetchAll<Folder, Folder>( m_dbConn, req );
}
209 210 211 212 213 214 215

bool FsDiscoverer::isBlacklisted(const std::string& path, const std::vector<std::shared_ptr<Folder>>& blacklist ) const
{
    return std::find_if( begin( blacklist ), end( blacklist ), [&path]( const std::shared_ptr<Folder>& f ) {
        return path == f->path();
    }) != end( blacklist );
}
216

217
bool FsDiscoverer::addFolder( fs::IDirectory* folder, Folder* parentFolder, const std::vector<std::shared_ptr<Folder>>& blacklist ) const
218 219 220 221
{
    // Force <0> as lastModificationDate, so this folder is detected as outdated
    // by the modification checking code
    auto deviceFs = folder->device();
222 223 224 225
    // We are creating a folder, there has to be a device containing it.
    assert( deviceFs != nullptr );
    auto device = Device::fromUuid( m_dbConn, deviceFs->uuid() );
    if ( device == nullptr )
226
    {
227 228
        LOG_INFO( "Creating new device in DB ", deviceFs->uuid() );
        device = Device::create( m_dbConn, deviceFs->uuid(), deviceFs->isRemovable() );
229 230
    }

231 232
    auto f = Folder::create( m_dbConn, folder->path(), 0,
                             parentFolder != nullptr ? parentFolder->id() : 0, *device );
233 234 235 236 237 238 239
    if ( f == nullptr )
        return false;
    checkFiles( folder, f.get() );
    checkSubfolders( folder, f.get(), blacklist );
    f->setLastModificationDate( folder->lastModificationDate() );
    return true;
}