FsDiscoverer.cpp 10.8 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 25 26
#if HAVE_CONFIG_H
# include "config.h"
#endif

27 28
#include "FsDiscoverer.h"

29
#include <algorithm>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
30 31
#include <queue>

32
#include "factory/FileSystemFactory.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
33
#include "filesystem/IDevice.h"
34
#include "Media.h"
35
#include "File.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
36
#include "Device.h"
37
#include "Folder.h"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
38
#include "logging/Logger.h"
39
#include "MediaLibrary.h"
40
#include "utils/Filename.h"
41

42 43 44
namespace medialibrary
{

45
FsDiscoverer::FsDiscoverer( std::shared_ptr<factory::IFileSystem> fsFactory, MediaLibrary* ml, IMediaLibraryCb* cb )
46
    : m_ml( ml )
47
    , m_fsFactory( fsFactory )
48
    , m_cb( cb )
49 50 51
{
}

52
bool FsDiscoverer::discover( const std::string &entryPoint )
53
{
54
    LOG_INFO( "Adding to discovery list: ", entryPoint );
55
    // Assume :// denotes a scheme that isn't a file path, and refuse to discover it.
56 57

    if ( m_fsFactory->isPathSupported( entryPoint ) == false )
58
        return false;
59

60 61
    std::shared_ptr<fs::IDirectory> fsDir = m_fsFactory->createDirectory( entryPoint );
    // Otherwise, create a directory and check it for modifications
62 63 64 65 66
    if ( fsDir == nullptr )
    {
        LOG_ERROR("Failed to create an IDirectory for ", entryPoint );
        return false;
    }
67
    auto f = Folder::fromPath( m_ml, fsDir->path() );
68 69 70
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
71
    if ( hasDotNoMediaFile( *fsDir ) )
72
        return true;
73 74 75 76 77 78 79 80 81
    try
    {
        return addFolder( *fsDir, nullptr );
    }
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted (assuming blacklisted folder): ", ex.what() );
    }
    return true;
82 83
}

84
bool FsDiscoverer::reload()
85
{
86
    LOG_INFO( "Reloading all folders" );
87
    // Start by checking if previously known devices have been plugged/unplugged
88 89 90 91 92
    if ( checkDevices() == false )
    {
        LOG_ERROR( "Refusing to reloading files with no storage device" );
        return false;
    }
93
    auto rootFolders = Folder::fetchRootFolders( m_ml );
94
    for ( const auto& f : rootFolders )
95
    {
96
        auto folder = m_fsFactory->createDirectory( f->path() );
97 98 99
        if ( folder == nullptr )
        {
            LOG_INFO( "Removing folder ", f->path() );
100
            m_ml->deleteFolder( *f );
101 102
            continue;
        }
103
        checkFolder( *folder, *f, false );
104
    }
105
    return true;
106 107
}

108
bool FsDiscoverer::reload( const std::string& entryPoint )
109
{
110 111
    if ( m_fsFactory->isPathSupported( entryPoint ) == false )
        return false;
112
    LOG_INFO( "Reloading folder ", entryPoint );
113 114 115 116 117 118
    // Start by checking if previously known devices have been plugged/unplugged
    if ( checkDevices() == false )
    {
        LOG_ERROR( "Refusing to reloading files with no storage device" );
        return false;
    }
119
    auto folder = Folder::fromPath( m_ml, entryPoint );
120 121 122
    if ( folder == nullptr )
    {
        LOG_ERROR( "Can't reload ", entryPoint, ": folder wasn't found in database" );
123
        return false;
124 125 126 127 128
    }
    auto folderFs = m_fsFactory->createDirectory( folder->path() );
    if ( folderFs == nullptr )
    {
        LOG_ERROR(" Failed to create a fs::IDirectory representing ", folder->path() );
129
        return false;
130
    }
131
    checkFolder( *folderFs, *folder, false );
132
    return true;
133 134
}

135
bool FsDiscoverer::checkDevices()
136
{
137 138
    if ( m_fsFactory->refreshDevices() == false )
        return false;
139
    auto devices = Device::fetchAll( m_ml );
140 141 142 143 144 145 146 147 148 149 150 151 152 153
    for ( auto& d : devices )
    {
        auto deviceFs = m_fsFactory->createDevice( d->uuid() );
        auto fsDevicePresent = deviceFs != nullptr && deviceFs->isPresent();
        if ( d->isPresent() != fsDevicePresent )
        {
            LOG_INFO( "Device ", d->uuid(), " changed presence state: ", d->isPresent(), " -> ", fsDevicePresent );
            d->setPresent( fsDevicePresent );
        }
        else
        {
            LOG_INFO( "Device ", d->uuid(), " unchanged" );
        }
    }
154
    return true;
155 156
}

157
void FsDiscoverer::checkFolder( fs::IDirectory& currentFolderFs, Folder& currentFolder, bool newFolder ) const
158
{
159 160
    // We already know of this folder, though it may now contain a .nomedia file.
    // In this case, simply delete the folder.
161
    if ( hasDotNoMediaFile( currentFolderFs ) )
162
    {
163 164
        LOG_INFO( "Deleting folder ", currentFolderFs.path(), " due to a .nomedia file" );
        m_ml->deleteFolder( currentFolder );
165
        return;
166
    }
167
    m_cb->onDiscoveryProgress( currentFolderFs.path() );
168
    // Load the folders we already know of:
169
    LOG_INFO( "Checking for modifications in ", currentFolderFs.path() );
170 171 172
    // Don't try to fetch any potential sub folders if the folder was freshly added
    std::vector<std::shared_ptr<Folder>> subFoldersInDB;
    if ( newFolder == false )
173
        subFoldersInDB = currentFolder.folders();
174
    for ( const auto& subFolder : currentFolderFs.dirs() )
175
    {
176 177
        auto it = std::find_if( begin( subFoldersInDB ), end( subFoldersInDB ), [&subFolder](const std::shared_ptr<Folder>& f) {
            return f->path() == subFolder->path();
178 179 180
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
181
        {
182 183 184 185 186
            if ( hasDotNoMediaFile( *subFolder ) )
            {
                LOG_INFO( "Ignoring folder with a .nomedia file" );
                continue;
            }
187
            LOG_INFO( "New folder detected: ", subFolder->path() );
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
            try
            {
                addFolder( *subFolder, &currentFolder );
                continue;
            }
            catch ( sqlite::errors::ConstraintViolation& ex )
            {
                // Best attempt to detect a foreign key violation, indicating the parent folders have been
                // deleted due to blacklisting
                if ( strstr( ex.what(), "foreign key" ) != NULL )
                {
                    LOG_WARN( "Creation of a folder failed because the parent is non existing: ", ex.what(),
                              ". Assuming it was deleted due to blacklisting" );
                    return;
                }
                LOG_WARN( "Creation of a duplicated folder failed: ", ex.what(), ". Assuming it was blacklisted" );
                continue;
            }
206
        }
207
        auto folderInDb = *it;
208 209 210
        // 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
211
        checkFolder( *subFolder, *folderInDb, false );
212 213 214 215 216
        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 )
    {
217
        LOG_INFO( "Folder ", f->path(), " not found in FS, deleting it" );
218
        m_ml->deleteFolder( *f );
219
    }
220
    checkFiles( currentFolderFs, currentFolder );
221
    LOG_INFO( "Done checking subfolders in ", currentFolderFs.path() );
222
}
223

224
void FsDiscoverer::checkFiles( fs::IDirectory& parentFolderFs, Folder& parentFolder ) const
225
{
226
    LOG_INFO( "Checking file in ", parentFolderFs.path() );
227
    static const std::string req = "SELECT * FROM " + policy::FileTable::Name
228
            + " WHERE folder_id = ?";
229
    auto files = File::fetchAll<File>( m_ml, req, parentFolder.id() );
230
    std::vector<std::shared_ptr<fs::IFile>> filesToAdd;
231
    std::vector<std::shared_ptr<File>> filesToRemove;
232
    for ( const auto& fileFs: parentFolderFs.files() )
233
    {
234 235
        auto it = std::find_if( begin( files ), end( files ), [fileFs](const std::shared_ptr<File>& f) {
            return f->mrl() == fileFs->fullPath();
236 237 238
        });
        if ( it == end( files ) )
        {
239
            filesToAdd.push_back( fileFs );
240
            continue;
241
        }
242
        if ( fileFs->lastModificationDate() == (*it)->lastModificationDate() )
243
        {
244 245 246
            // Unchanged file
            files.erase( it );
            continue;
247
        }
248
        auto& file = (*it);
249
        LOG_INFO( "Forcing file refresh ", fileFs->fullPath() );
250 251 252 253
        // Pre-cache the file's media, since we need it to remove. However, better doing it
        // out of a write context, since that way, other threads can also read the database.
        file->media();
        filesToRemove.push_back( file );
254
        filesToAdd.push_back( fileFs );
255 256
        files.erase( it );
    }
257
    auto t = m_ml->getConn()->newTransaction();
258 259
    for ( auto file : files )
    {
260
        LOG_INFO( "File ", file->mrl(), " not found on filesystem, deleting it" );
261
        file->media()->removeFile( *file );
262
    }
263 264 265 266
    for ( auto& f : filesToRemove )
        f->media()->removeFile( *f );
    // Insert all files at once to avoid SQL write contention
    for ( auto& p : filesToAdd )
267
        m_ml->addFile( *p, parentFolder, parentFolderFs );
268
    t->commit();
269
    LOG_INFO( "Done checking files in ", parentFolderFs.path() );
270
}
271

272 273 274
bool FsDiscoverer::hasDotNoMediaFile( const fs::IDirectory& directory )
{
    const auto& files = directory.files();
275 276
    return std::find_if( begin( files ), end( files ), []( const std::shared_ptr<fs::IFile>& file ){
        return file->name() == ".nomedia";
277 278 279
    }) != end( files );
}

280
bool FsDiscoverer::addFolder( fs::IDirectory& folder, Folder* parentFolder ) const
281
{
282
    auto deviceFs = folder.device();
283 284
    // We are creating a folder, there has to be a device containing it.
    assert( deviceFs != nullptr );
285
    auto device = Device::fromUuid( m_ml, deviceFs->uuid() );
286
    if ( device == nullptr )
287
    {
288
        LOG_INFO( "Creating new device in DB ", deviceFs->uuid() );
289
        device = Device::create( m_ml, deviceFs->uuid(), deviceFs->isRemovable() );
290 291
    }

292
    auto f = Folder::create( m_ml, folder.path(),
293
                             parentFolder != nullptr ? parentFolder->id() : 0,
294
                             *device, *deviceFs );
295 296
    if ( f == nullptr )
        return false;
297
    checkFolder( folder, *f, true );
298 299
    return true;
}
300

301
}