FsDiscoverer.cpp 12.9 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 45 46 47 48 49 50 51 52 53 54 55
namespace
{

class DeviceRemovedException : public std::runtime_error
{
public:
    DeviceRemovedException() noexcept
        : std::runtime_error( "A device was removed during the discovery" )
    {
    }
};

}

56 57 58
namespace medialibrary
{

59
FsDiscoverer::FsDiscoverer( std::shared_ptr<factory::IFileSystem> fsFactory, MediaLibrary* ml, IMediaLibraryCb* cb )
60
    : m_ml( ml )
61
    , m_fsFactory( fsFactory )
62
    , m_cb( cb )
63 64 65
{
}

66
bool FsDiscoverer::discover( const std::string &entryPoint )
67
{
68
    LOG_INFO( "Adding to discovery list: ", entryPoint );
69

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
70
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
71
        return false;
72

73 74
    std::shared_ptr<fs::IDirectory> fsDir = m_fsFactory->createDirectory( entryPoint );
    // Otherwise, create a directory and check it for modifications
75 76 77 78 79
    if ( fsDir == nullptr )
    {
        LOG_ERROR("Failed to create an IDirectory for ", entryPoint );
        return false;
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
80
    auto f = Folder::fromMrl( m_ml, fsDir->mrl() );
81 82 83
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
84 85
    try
    {
86 87
        if ( hasDotNoMediaFile( *fsDir ) )
            return true;
88 89
        return addFolder( *fsDir, nullptr );
    }
90 91 92 93
    catch ( std::system_error& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted because of a filesystem error: ", ex.what() );
    }
94 95 96 97
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted (assuming blacklisted folder): ", ex.what() );
    }
98 99 100 101 102
    catch ( DeviceRemovedException& )
    {
        // Simply ignore, the device has already been marked as removed and the DB updated accordingly
        LOG_INFO( "Discovery of ", fsDir->mrl(), " was stopped after the device was removed" );
    }
103
    return true;
104 105
}

106 107 108
void FsDiscoverer::reloadFolder( Folder& f )
{
    auto folder = m_fsFactory->createDirectory( f.mrl() );
109 110 111 112 113 114 115 116
    try
    {
        checkFolder( *folder, f, false );
    }
    catch ( DeviceRemovedException& )
    {
        LOG_INFO( "Reloading of ", f.mrl(), " was stopped after the device was removed" );
    }
117 118
}

119
bool FsDiscoverer::reload()
120
{
121
    LOG_INFO( "Reloading all folders" );
122
    auto rootFolders = Folder::fetchRootFolders( m_ml );
123
    for ( const auto& f : rootFolders )
124
        reloadFolder( *f );
125
    return true;
126 127
}

128
bool FsDiscoverer::reload( const std::string& entryPoint )
129
{
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
130
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
131
        return false;
132
    LOG_INFO( "Reloading folder ", entryPoint );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
133
    auto folder = Folder::fromMrl( m_ml, entryPoint );
134 135 136
    if ( folder == nullptr )
    {
        LOG_ERROR( "Can't reload ", entryPoint, ": folder wasn't found in database" );
137
        return false;
138
    }
139
    reloadFolder( *folder );
140
    return true;
141 142
}

143
void FsDiscoverer::checkFolder( fs::IDirectory& currentFolderFs, Folder& currentFolder, bool newFolder ) const
144
{
145 146 147 148 149 150
    try
    {
        // We already know of this folder, though it may now contain a .nomedia file.
        // In this case, simply delete the folder.
        if ( hasDotNoMediaFile( currentFolderFs ) )
        {
151 152 153 154 155
            if ( newFolder == false )
            {
                LOG_INFO( "Deleting folder ", currentFolderFs.mrl(), " due to a .nomedia file" );
                m_ml->deleteFolder( currentFolder );
            }
156 157
            else
                LOG_INFO( "Ignoring folder ", currentFolderFs.mrl(), " due to a .nomedia file" );
158 159 160 161
            return;
        }
    }
    // Only check once for a system_error. They are bound to happen when we list the files/folders
162
    // within, and hasDotMediaFile is the first place when this is done
163
    catch ( std::system_error& ex )
164
    {
165
        LOG_WARN( "Failed to browse ", currentFolderFs.mrl(), ": ", ex.what() );
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
        // Even when we're discovering a new folder, we want to rule out device removal as the cause of
        // an IO error. If this is the cause, simply abort the discovery. All the folder we have
        // discovered so far will be marked as non-present through sqlite hooks, and we'll resume the
        // discovery when the device gets plugged back in
        if ( currentFolderFs.device()->isRemovable() )
        {
            // If the device is removable, check if it was indeed removed.
            LOG_INFO( "The device containing ", currentFolderFs.mrl(), " is removable. Checking for device removal..." );
            m_ml->refreshDevices( *m_fsFactory );
            // The device presence flag will be changed in place, so simply retest it
            if ( currentFolderFs.device()->isPresent() == false )
                throw DeviceRemovedException();
            LOG_INFO( "Device was not removed" );
        }
        // However if the device isn't removable, we want to:
        // - ignore it when we're discovering a new folder.
        // - delete it when it was discovered in the past. This is likely to be due to a permission change
        //   as we would not check the folder if it wasn't present during the parent folder browsing
        //   but it might also be that we're checking an entry point.
        //   The error won't arise earlier, as we only perform IO when reading the folder from this function.
186 187 188 189 190
        if ( newFolder == false )
        {
            // If we ever came across this folder, its content is now unaccessible: let's remove it.
            m_ml->deleteFolder( currentFolder );
        }
191
        return;
192
    }
193

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
194
    m_cb->onDiscoveryProgress( currentFolderFs.mrl() );
195
    // Load the folders we already know of:
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
196
    LOG_INFO( "Checking for modifications in ", currentFolderFs.mrl() );
197 198 199
    // 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 )
200
        subFoldersInDB = currentFolder.folders();
201
    for ( const auto& subFolder : currentFolderFs.dirs() )
202
    {
203
        auto it = std::find_if( begin( subFoldersInDB ), end( subFoldersInDB ), [&subFolder](const std::shared_ptr<Folder>& f) {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
204
            return f->mrl() == subFolder->mrl();
205 206 207
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
208
        {
209 210 211 212 213
            if ( hasDotNoMediaFile( *subFolder ) )
            {
                LOG_INFO( "Ignoring folder with a .nomedia file" );
                continue;
            }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
214
            LOG_INFO( "New folder detected: ", subFolder->mrl() );
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
            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;
            }
233
        }
234
        auto folderInDb = *it;
235 236 237
        // 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
238
        checkFolder( *subFolder, *folderInDb, false );
239 240 241 242 243
        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 )
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
244
        LOG_INFO( "Folder ", f->mrl(), " not found in FS, deleting it" );
245
        m_ml->deleteFolder( *f );
246
    }
247
    checkFiles( currentFolderFs, currentFolder );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
248
    LOG_INFO( "Done checking subfolders in ", currentFolderFs.mrl() );
249
}
250

251
void FsDiscoverer::checkFiles( fs::IDirectory& parentFolderFs, Folder& parentFolder ) const
252
{
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
253
    LOG_INFO( "Checking file in ", parentFolderFs.mrl() );
254
    static const std::string req = "SELECT * FROM " + policy::FileTable::Name
255
            + " WHERE folder_id = ?";
256
    auto files = File::fetchAll<File>( m_ml, req, parentFolder.id() );
257
    std::vector<std::shared_ptr<fs::IFile>> filesToAdd;
258
    std::vector<std::shared_ptr<File>> filesToRemove;
259
    for ( const auto& fileFs: parentFolderFs.files() )
260
    {
261
        auto it = std::find_if( begin( files ), end( files ), [fileFs](const std::shared_ptr<File>& f) {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
262
            return f->mrl() == fileFs->mrl();
263 264 265
        });
        if ( it == end( files ) )
        {
266
            filesToAdd.push_back( std::move( fileFs ) );
267
            continue;
268
        }
269
        if ( fileFs->lastModificationDate() == (*it)->lastModificationDate() )
270
        {
271 272 273
            // Unchanged file
            files.erase( it );
            continue;
274
        }
275
        auto& file = (*it);
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
276
        LOG_INFO( "Forcing file refresh ", fileFs->mrl() );
277 278 279
        // 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();
280 281
        filesToRemove.push_back( std::move( file ) );
        filesToAdd.push_back( std::move( fileFs ) );
282 283
        files.erase( it );
    }
284
    auto t = m_ml->getConn()->newTransaction();
285 286
    for ( auto file : files )
    {
287
        LOG_INFO( "File ", file->mrl(), " not found on filesystem, deleting it" );
288 289 290 291 292 293 294 295 296 297
        auto media = file->media();
        if ( media != nullptr && media->isDeleted() == false )
            media->removeFile( *file );
        else if ( file->isDeleted() == false )
        {
            // This is unexpected, as the file should have been deleted when the media was
            // removed.
            LOG_WARN( "Deleting a file without an associated media." );
            file->destroy();
        }
298
    }
299
    for ( auto& f : filesToRemove )
300 301 302 303 304 305 306 307 308 309 310
    {
        auto media = f->media();
        if ( media != nullptr )
            media->removeFile( *f );
        else
        {
            // If there is no media associated with this file, the file had to be removed through
            // a trigger
            assert( f->isDeleted() );
        }
    }
311 312
    // Insert all files at once to avoid SQL write contention
    for ( auto& p : filesToAdd )
313
        m_ml->addFile( *p, parentFolder, parentFolderFs );
314
    t->commit();
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
315
    LOG_INFO( "Done checking files in ", parentFolderFs.mrl() );
316
}
317

318 319 320
bool FsDiscoverer::hasDotNoMediaFile( const fs::IDirectory& directory )
{
    const auto& files = directory.files();
321 322
    return std::find_if( begin( files ), end( files ), []( const std::shared_ptr<fs::IFile>& file ){
        return file->name() == ".nomedia";
323 324 325
    }) != end( files );
}

326
bool FsDiscoverer::addFolder( fs::IDirectory& folder, Folder* parentFolder ) const
327
{
328
    auto deviceFs = folder.device();
329 330
    // We are creating a folder, there has to be a device containing it.
    assert( deviceFs != nullptr );
331
    auto device = Device::fromUuid( m_ml, deviceFs->uuid() );
332
    if ( device == nullptr )
333
    {
334
        LOG_INFO( "Creating new device in DB ", deviceFs->uuid() );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
335 336
        device = Device::create( m_ml, deviceFs->uuid(), utils::file::scheme( folder.mrl() ),
                                 deviceFs->isRemovable() );
337 338
    }

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
339
    auto f = Folder::create( m_ml, folder.mrl(),
340
                             parentFolder != nullptr ? parentFolder->id() : 0,
341
                             *device, *deviceFs );
342 343
    if ( f == nullptr )
        return false;
344
    checkFolder( folder, *f, true );
345 346
    return true;
}
347

348
}