FsDiscoverer.cpp 13.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"
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
34
#include "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 "utils/Filename.h"
42

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

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

}

57 58 59
namespace medialibrary
{

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

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

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

74
    std::shared_ptr<fs::IDirectory> fsDir = m_fsFactory->createDirectory( entryPoint );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
75
    auto f = Folder::fromMrl( m_ml, fsDir->mrl() );
76 77 78
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
79 80
    try
    {
81 82
        if ( hasDotNoMediaFile( *fsDir ) )
            return true;
83
        return addFolder( std::move( fsDir ), nullptr );
84
    }
85 86 87 88
    catch ( std::system_error& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted because of a filesystem error: ", ex.what() );
    }
89 90 91 92
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted (assuming blacklisted folder): ", ex.what() );
    }
93 94 95 96 97
    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" );
    }
98
    return true;
99 100
}

101
void FsDiscoverer::reloadFolder( std::shared_ptr<Folder> f )
102
{
103
    auto folder = m_fsFactory->createDirectory( f->mrl() );
104 105
    try
    {
106
        checkFolder( std::move( folder ), std::move( f ), false );
107 108 109
    }
    catch ( DeviceRemovedException& )
    {
110
        LOG_INFO( "Reloading of ", f->mrl(), " was stopped after the device was removed" );
111
    }
112 113
}

114
bool FsDiscoverer::reload()
115
{
116
    LOG_INFO( "Reloading all folders" );
117
    auto rootFolders = Folder::fetchRootFolders( m_ml );
118 119
    for ( const auto& f : rootFolders )
        reloadFolder( f );
120
    return true;
121 122
}

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

138 139 140
void FsDiscoverer::checkFolder( std::shared_ptr<fs::IDirectory> currentFolderFs,
                                std::shared_ptr<Folder> currentFolder,
                                bool newFolder ) const
141
{
142 143 144 145
    try
    {
        // We already know of this folder, though it may now contain a .nomedia file.
        // In this case, simply delete the folder.
146
        if ( hasDotNoMediaFile( *currentFolderFs ) )
147
        {
148 149
            if ( newFolder == false )
            {
150 151
                LOG_INFO( "Deleting folder ", currentFolderFs->mrl(), " due to a .nomedia file" );
                m_ml->deleteFolder( *currentFolder );
152
            }
153
            else
154
                LOG_INFO( "Ignoring folder ", currentFolderFs->mrl(), " due to a .nomedia file" );
155 156 157 158
            return;
        }
    }
    // Only check once for a system_error. They are bound to happen when we list the files/folders
159
    // within, and hasDotMediaFile is the first place when this is done
160
    catch ( std::system_error& ex )
161
    {
162
        LOG_WARN( "Failed to browse ", currentFolderFs->mrl(), ": ", ex.what() );
163 164 165 166
        // 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
167
        if ( currentFolderFs->device()->isRemovable() )
168 169
        {
            // If the device is removable, check if it was indeed removed.
170
            LOG_INFO( "The device containing ", currentFolderFs->mrl(), " is removable. Checking for device removal..." );
171 172
            m_ml->refreshDevices( *m_fsFactory );
            // The device presence flag will be changed in place, so simply retest it
173
            if ( currentFolderFs->device()->isPresent() == false )
174 175 176 177 178 179 180 181 182
                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.
183 184 185
        if ( newFolder == false )
        {
            // If we ever came across this folder, its content is now unaccessible: let's remove it.
186
            m_ml->deleteFolder( *currentFolder );
187
        }
188
        return;
189
    }
190

191
    m_cb->onDiscoveryProgress( currentFolderFs->mrl() );
192
    // Load the folders we already know of:
193
    LOG_INFO( "Checking for modifications in ", currentFolderFs->mrl() );
194 195 196
    // 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 )
197 198
        subFoldersInDB = currentFolder->folders();
    for ( const auto& subFolder : currentFolderFs->dirs() )
199
    {
200
        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
201
            return f->mrl() == subFolder->mrl();
202 203 204
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
205
        {
206 207 208 209 210
            if ( hasDotNoMediaFile( *subFolder ) )
            {
                LOG_INFO( "Ignoring folder with a .nomedia file" );
                continue;
            }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
211
            LOG_INFO( "New folder detected: ", subFolder->mrl() );
212 213
            try
            {
214
                addFolder( subFolder, currentFolder.get() );
215 216 217 218 219 220
                continue;
            }
            catch ( sqlite::errors::ConstraintViolation& ex )
            {
                // Best attempt to detect a foreign key violation, indicating the parent folders have been
                // deleted due to blacklisting
221
                if ( strstr( ex.what(), "foreign key" ) != nullptr )
222 223 224 225 226 227 228 229
                {
                    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;
            }
230
        }
231
        auto folderInDb = *it;
232 233 234
        // 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
235
        checkFolder( subFolder, folderInDb, false );
236 237 238
        subFoldersInDB.erase( it );
    }
    // Now all folders we had in DB but haven't seen from the FS must have been deleted.
239
    for ( const auto& f : subFoldersInDB )
240
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
241
        LOG_INFO( "Folder ", f->mrl(), " not found in FS, deleting it" );
242
        m_ml->deleteFolder( *f );
243
    }
244
    checkFiles( currentFolderFs, currentFolder );
245
    LOG_INFO( "Done checking subfolders in ", currentFolderFs->mrl() );
246
}
247

248 249
void FsDiscoverer::checkFiles( std::shared_ptr<fs::IDirectory> parentFolderFs,
                               std::shared_ptr<Folder> parentFolder ) const
250
{
251
    LOG_INFO( "Checking file in ", parentFolderFs->mrl() );
252
    static const std::string req = "SELECT * FROM " + policy::FileTable::Name
253
            + " WHERE folder_id = ?";
254
    auto files = File::fetchAll<File>( m_ml, req, parentFolder->id() );
255
    std::vector<std::shared_ptr<fs::IFile>> filesToAdd;
256
    std::vector<std::shared_ptr<File>> filesToRemove;
257
    for ( const auto& fileFs: parentFolderFs->files() )
258
    {
259
        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
260
            return f->mrl() == fileFs->mrl();
261 262 263
        });
        if ( it == end( files ) )
        {
264 265
            if ( MediaLibrary::isExtensionSupported( fileFs->extension().c_str() ) == true )
                filesToAdd.push_back( fileFs );
266
            continue;
267
        }
268
        if ( fileFs->lastModificationDate() == (*it)->lastModificationDate() )
269
        {
270 271 272
            // Unchanged file
            files.erase( it );
            continue;
273
        }
274
        auto& file = (*it);
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
275
        LOG_INFO( "Forcing file refresh ", fileFs->mrl() );
276 277 278
        // 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();
279
        filesToRemove.push_back( std::move( file ) );
280
        filesToAdd.push_back( fileFs );
281 282
        files.erase( it );
    }
283 284 285 286 287 288 289
    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();
        for ( auto file : files )
290
        {
291 292 293 294 295 296 297 298 299 300 301
            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();
            }
302
        }
303
        for ( auto& f : filesToRemove )
304
        {
305 306 307 308 309 310 311 312 313
            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() );
            }
314
        }
315 316
        // Insert all files at once to avoid SQL write contention
        for ( auto& p : filesToAdd )
317
            m_ml->addFile( p, parentFolder, parentFolderFs );
318
        t->commit();
319
        LOG_INFO( "Done checking files in ", parentFolderFs->mrl() );
320
    }, std::move( files ), std::move( filesToAdd ), std::move( filesToRemove ) );
321
}
322

323 324 325
bool FsDiscoverer::hasDotNoMediaFile( const fs::IDirectory& directory )
{
    const auto& files = directory.files();
326
    return std::find_if( begin( files ), end( files ), []( const std::shared_ptr<fs::IFile>& file ){
327
        return strcasecmp( file->name().c_str(), ".nomedia" ) == 0;
328 329 330
    }) != end( files );
}

331 332
bool FsDiscoverer::addFolder( std::shared_ptr<fs::IDirectory> folder,
                              Folder* parentFolder ) const
333
{
334
    auto deviceFs = folder->device();
335 336
    // We are creating a folder, there has to be a device containing it.
    assert( deviceFs != nullptr );
337
    auto device = Device::fromUuid( m_ml, deviceFs->uuid() );
338
    if ( device == nullptr )
339
    {
340
        LOG_INFO( "Creating new device in DB ", deviceFs->uuid() );
341 342
        device = Device::create( m_ml, deviceFs->uuid(),
                                 utils::file::scheme( folder->mrl() ),
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
343
                                 deviceFs->isRemovable() );
344 345
        if ( device == nullptr )
            return false;
346 347
    }

348
    auto f = Folder::create( m_ml, folder->mrl(),
349
                             parentFolder != nullptr ? parentFolder->id() : 0,
350
                             *device, *deviceFs );
351 352
    if ( f == nullptr )
        return false;
353
    checkFolder( std::move( folder ), std::move( f ), true );
354 355
    return true;
}
356

357
}