FsDiscoverer.cpp 13.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
#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 75
    std::shared_ptr<fs::IDirectory> fsDir = m_fsFactory->createDirectory( entryPoint );
    // Otherwise, create a directory and check it for modifications
76 77 78 79 80
    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
81
    auto f = Folder::fromMrl( m_ml, fsDir->mrl() );
82 83 84
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
85 86
    try
    {
87 88
        if ( hasDotNoMediaFile( *fsDir ) )
            return true;
89
        return addFolder( std::move( fsDir ), nullptr );
90
    }
91 92 93 94
    catch ( std::system_error& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted because of a filesystem error: ", ex.what() );
    }
95 96 97 98
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted (assuming blacklisted folder): ", ex.what() );
    }
99 100 101 102 103
    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" );
    }
104
    return true;
105 106
}

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

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

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

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

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

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

329 330 331
bool FsDiscoverer::hasDotNoMediaFile( const fs::IDirectory& directory )
{
    const auto& files = directory.files();
332
    return std::find_if( begin( files ), end( files ), []( const std::shared_ptr<fs::IFile>& file ){
333
        return strcasecmp( file->name().c_str(), ".nomedia" ) == 0;
334 335 336
    }) != end( files );
}

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

354
    auto f = Folder::create( m_ml, folder->mrl(),
355
                             parentFolder != nullptr ? parentFolder->id() : 0,
356
                             *device, *deviceFs );
357 358
    if ( f == nullptr )
        return false;
359
    checkFolder( std::move( folder ), std::move( f ), true );
360 361
    return true;
}
362

363
}