FsDiscoverer.cpp 15.7 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
#include <queue>
31
#include <utility>
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
32

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

44 45 46 47 48 49 50 51 52 53 54 55 56 57
namespace
{

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

}

58 59 60
namespace medialibrary
{

61
FsDiscoverer::FsDiscoverer( std::shared_ptr<fs::IFileSystemFactory> fsFactory, MediaLibrary* ml, IMediaLibraryCb* cb, std::unique_ptr<prober::IProbe> probe )
62
    : m_ml( ml )
63
    , m_fsFactory( std::move( fsFactory ))
64
    , m_cb( cb )
65
    , m_probe( std::move( probe ) )
66 67 68
{
}

69
bool FsDiscoverer::discover( const std::string& entryPoint )
70
{
71
    LOG_INFO( "Running discover on: ", entryPoint );
72

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
73
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
74
        return false;
75

76 77 78 79 80 81 82 83 84 85
    std::shared_ptr<fs::IDirectory> fsDir;
    try
    {
        fsDir = m_fsFactory->createDirectory( entryPoint );
    }
    catch ( std::system_error& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted because of a filesystem error: ", ex.what() );
        return true;
    }
86
    auto fsDirMrl = fsDir->mrl(); // Saving MRL now since we might need it after fsDir is moved
87
    auto f = Folder::fromMrl( m_ml, fsDirMrl );
88 89 90
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
91 92
    try
    {
93
        if ( m_probe->proceedOnDirectory( *fsDir ) == false || m_probe->isHidden( *fsDir ) == true )
94
            return true;
95 96 97
        // Fetch files explicitly
        fsDir->files();
        return addFolder( std::move( fsDir ), m_probe->getFolderParent().get() );
98 99 100
    }
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
101
        LOG_WARN( fsDirMrl, " discovery aborted (assuming blacklisted folder): ", ex.what() );
102
    }
103 104 105
    catch ( DeviceRemovedException& )
    {
        // Simply ignore, the device has already been marked as removed and the DB updated accordingly
106
        LOG_INFO( "Discovery of ", fsDirMrl, " was stopped after the device was removed" );
107
    }
108
    return true;
109 110
}

111
void FsDiscoverer::reloadFolder( std::shared_ptr<Folder> f )
112
{
113
    assert( f->isPresent() );
114
    auto mrl = f->mrl();
115

116
    std::shared_ptr<fs::IDirectory> directory;
117 118
    try
    {
119 120 121
        directory = m_fsFactory->createDirectory( mrl );
        assert( directory->device() != nullptr );
        if ( directory->device() == nullptr )
122
            return;
123
    }
124 125 126 127
    catch ( const std::system_error& ex )
    {
        LOG_INFO( "Failed to instanciate a directory for ", mrl, ": ", ex.what(),
                  ". Can't reload the folder." );
128 129 130 131
        return;
    }
    try
    {
132
        checkFolder( std::move( directory ), std::move( f ), false );
133
    }
134 135 136 137 138
    catch ( DeviceRemovedException& )
    {
        LOG_INFO( "Reloading of ", mrl, " was stopped after the device was removed" );
    }

139 140
}

141
bool FsDiscoverer::reload()
142
{
143
    LOG_INFO( "Reloading all folders" );
144
    auto rootFolders = Folder::fetchRootFolders( m_ml );
145
    for ( const auto& f : rootFolders )
146 147 148
    {
        // fetchRootFolders only returns present folders
        assert( f->isPresent() == true );
149
        reloadFolder( f );
150
    }
151
    return true;
152 153
}

154
bool FsDiscoverer::reload( const std::string& entryPoint )
155
{
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
156
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
157
        return false;
158
    LOG_INFO( "Reloading folder ", entryPoint );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
159
    auto folder = Folder::fromMrl( m_ml, entryPoint );
160 161 162
    if ( folder == nullptr )
    {
        LOG_ERROR( "Can't reload ", entryPoint, ": folder wasn't found in database" );
163
        return false;
164
    }
165 166 167 168 169 170
    if ( folder->isPresent() == false )
    {
        LOG_INFO( "Folder ", entryPoint, " isn't present, and therefore won't "
                  "be reloaded" );
        return false;
    }
171
    reloadFolder( std::move( folder ) );
172
    return true;
173 174
}

175 176 177
void FsDiscoverer::checkFolder( std::shared_ptr<fs::IDirectory> currentFolderFs,
                                std::shared_ptr<Folder> currentFolder,
                                bool newFolder ) const
178
{
179 180 181 182
    try
    {
        // We already know of this folder, though it may now contain a .nomedia file.
        // In this case, simply delete the folder.
183
        if ( m_probe->isHidden( *currentFolderFs ) == true )
184
        {
185
            if ( newFolder == false )
186
                m_ml->deleteFolder( *currentFolder );
187 188
            return;
        }
189 190
        // Ensuring that the file fetching is done in this scope, to catch errors
        currentFolderFs->files();
191 192
    }
    // Only check once for a system_error. They are bound to happen when we list the files/folders
193
    // within, and IProbe::isHidden is the first place when this is done
194
    catch ( std::system_error& ex )
195
    {
196
        LOG_WARN( "Failed to browse ", currentFolderFs->mrl(), ": ", ex.what() );
197 198 199 200
        // 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
201 202 203 204
        auto device = currentFolderFs->device();
        // The device might not be present at all, and therefor we might miss a
        // representation for it.
        if ( device == nullptr || device->isRemovable() )
205
        {
206 207 208 209 210
            // If the device is removable/missing, check if it was indeed removed.
            LOG_INFO( "The device containing ", currentFolderFs->mrl(), " is ",
                      device != nullptr ? "removable" : "not found",
                      ". Refreshing device cache..." );

211
            m_ml->refreshDevices( *m_fsFactory );
212 213 214 215
            // If the device was missing, refresh our list of devices in case
            // the device was plugged back and/or we missed a notification for it
            if ( device == nullptr )
                device = currentFolderFs->device();
216
            // The device presence flag will be changed in place, so simply retest it
217
            if ( device == nullptr || device->isPresent() == false )
218 219 220 221 222 223 224 225 226
                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.
227 228 229
        if ( newFolder == false )
        {
            // If we ever came across this folder, its content is now unaccessible: let's remove it.
230
            m_ml->deleteFolder( *currentFolder );
231
        }
232
        return;
233
    }
234

235 236
    if ( m_cb != nullptr )
        m_cb->onDiscoveryProgress( currentFolderFs->mrl() );
237
    // Load the folders we already know of:
238
    LOG_INFO( "Checking for modifications in ", currentFolderFs->mrl() );
239 240 241
    // 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 )
242 243
        subFoldersInDB = currentFolder->folders();
    for ( const auto& subFolder : currentFolderFs->dirs() )
244
    {
245 246
        if ( subFolder->device() == nullptr )
            continue;
247 248 249 250
        if ( m_probe->stopFileDiscovery() == true )
            break;
        if ( m_probe->proceedOnDirectory( *subFolder ) == false )
            continue;
251
        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
252
            return f->mrl() == subFolder->mrl();
253 254 255
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
256
        {
257
            if ( m_probe->isHidden( *subFolder ) )
258
                continue;
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
259
            LOG_INFO( "New folder detected: ", subFolder->mrl() );
260 261
            try
            {
262
                addFolder( subFolder, currentFolder.get() );
263 264 265 266 267 268
                continue;
            }
            catch ( sqlite::errors::ConstraintViolation& ex )
            {
                // Best attempt to detect a foreign key violation, indicating the parent folders have been
                // deleted due to blacklisting
269
                if ( strstr( ex.what(), "foreign key" ) != nullptr )
270 271 272 273 274 275 276 277
                {
                    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;
            }
278
        }
279
        auto folderInDb = *it;
280 281 282
        // 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
283
        checkFolder( subFolder, folderInDb, false );
284 285
        subFoldersInDB.erase( it );
    }
286
    if ( m_probe->deleteUnseenFolders() == true )
287
    {
288 289 290 291 292 293
        // Now all folders we had in DB but haven't seen from the FS must have been deleted.
        for ( const auto& f : subFoldersInDB )
        {
            LOG_INFO( "Folder ", f->mrl(), " not found in FS, deleting it" );
            m_ml->deleteFolder( *f );
        }
294
    }
295
    checkFiles( currentFolderFs, currentFolder );
296
    LOG_INFO( "Done checking subfolders in ", currentFolderFs->mrl() );
297
}
298

299 300
void FsDiscoverer::checkFiles( std::shared_ptr<fs::IDirectory> parentFolderFs,
                               std::shared_ptr<Folder> parentFolder ) const
301
{
302
    LOG_INFO( "Checking file in ", parentFolderFs->mrl() );
303
    static const std::string req = "SELECT * FROM " + policy::FileTable::Name
304
            + " WHERE folder_id = ?";
305
    auto files = File::fetchAll<File>( m_ml, req, parentFolder->id() );
306
    std::vector<std::shared_ptr<fs::IFile>> filesToAdd;
307
    std::vector<std::shared_ptr<File>> filesToRemove;
308
    for ( const auto& fileFs: parentFolderFs->files() )
309
    {
310 311 312 313
        if ( m_probe->stopFileDiscovery() == true )
            break;
        if ( m_probe->proceedOnFile( *fileFs ) == false )
            continue;
314
        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
315
            return f->mrl() == fileFs->mrl();
316
        });
317
        if ( it == end( files ) || m_probe->forceFileRefresh() == true )
318
        {
319 320
            if ( MediaLibrary::isExtensionSupported( fileFs->extension().c_str() ) == true )
                filesToAdd.push_back( fileFs );
321
            continue;
322
        }
323
        if ( fileFs->lastModificationDate() == (*it)->lastModificationDate() )
324
        {
325 326 327
            // Unchanged file
            files.erase( it );
            continue;
328
        }
329
        auto& file = (*it);
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
330
        LOG_INFO( "Forcing file refresh ", fileFs->mrl() );
331 332 333
        // 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();
334
        filesToRemove.push_back( std::move( file ) );
335
        filesToAdd.push_back( fileFs );
336 337
        files.erase( it );
    }
338 339
    if ( m_probe->deleteUnseenFiles() == false )
        files.clear();
340 341 342 343 344 345
    using FilesT = decltype( files );
    using FilesToRemoveT = decltype( filesToRemove );
    using FilesToAddT = decltype( filesToAdd );
    sqlite::Tools::withRetries( 3, [this, &parentFolder, &parentFolderFs]
                            ( FilesT files, FilesToAddT filesToAdd, FilesToRemoveT filesToRemove ) {
        auto t = m_ml->getConn()->newTransaction();
346
        for ( const auto& file : files )
347
        {
348 349 350 351 352 353 354 355 356 357 358
            LOG_INFO( "File ", file->mrl(), " not found on filesystem, deleting it" );
            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();
            }
359
        }
360
        for ( auto& f : filesToRemove )
361
        {
362 363 364 365 366
            if ( f->type() == IFile::Type::Playlist )
            {
                f->destroy(); // Trigger cascade: delete Playlist, and playlist/media relations
                continue;
            }
367 368 369 370 371 372 373 374 375
            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() );
            }
376
        }
377 378
        // Insert all files at once to avoid SQL write contention
        for ( auto& p : filesToAdd )
379
            m_ml->addDiscoveredFile( p, parentFolder, parentFolderFs, m_probe->getPlaylistParent() );
380
        t->commit();
381
        LOG_INFO( "Done checking files in ", parentFolderFs->mrl() );
382
    }, std::move( files ), std::move( filesToAdd ), std::move( filesToRemove ) );
383
}
384

385 386
bool FsDiscoverer::addFolder( std::shared_ptr<fs::IDirectory> folder,
                              Folder* parentFolder ) const
387
{
388
    auto deviceFs = folder->device();
389 390
    // We are creating a folder, there has to be a device containing it.
    assert( deviceFs != nullptr );
391 392 393
    // But gracefully handle failure in release mode
    if( deviceFs == nullptr )
        return false;
394
    auto device = Device::fromUuid( m_ml, deviceFs->uuid() );
395
    if ( device == nullptr )
396
    {
397
        LOG_INFO( "Creating new device in DB ", deviceFs->uuid() );
398 399
        device = Device::create( m_ml, deviceFs->uuid(),
                                 utils::file::scheme( folder->mrl() ),
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
400
                                 deviceFs->isRemovable() );
401 402
        if ( device == nullptr )
            return false;
403 404
    }

405
    auto f = Folder::create( m_ml, folder->mrl(),
406
                             parentFolder != nullptr ? parentFolder->id() : 0,
407
                             *device, *deviceFs );
408 409
    if ( f == nullptr )
        return false;
410
    checkFolder( std::move( folder ), std::move( f ), true );
411 412
    return true;
}
413

414
}