FsDiscoverer.cpp 10.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
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

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
56
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
57
        return false;
58

59 60
    std::shared_ptr<fs::IDirectory> fsDir = m_fsFactory->createDirectory( entryPoint );
    // Otherwise, create a directory and check it for modifications
61 62 63 64 65
    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
66
    auto f = Folder::fromMrl( m_ml, fsDir->mrl() );
67 68 69
    // If the folder exists, we assume it will be handled by reload()
    if ( f != nullptr )
        return true;
70 71
    try
    {
72 73
        if ( hasDotNoMediaFile( *fsDir ) )
            return true;
74 75
        return addFolder( *fsDir, nullptr );
    }
76 77 78 79 80
    catch ( std::system_error& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted because of a filesystem error: ", ex.what() );
    }

81 82 83 84 85
    catch ( sqlite::errors::ConstraintViolation& ex )
    {
        LOG_WARN( entryPoint, " discovery aborted (assuming blacklisted folder): ", ex.what() );
    }
    return true;
86 87
}

88
bool FsDiscoverer::reload()
89
{
90
    LOG_INFO( "Reloading all folders" );
91
    auto rootFolders = Folder::fetchRootFolders( m_ml );
92
    for ( const auto& f : rootFolders )
93
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
94
        auto folder = m_fsFactory->createDirectory( f->mrl() );
95 96
        if ( folder == nullptr )
        {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
97
            LOG_INFO( "Removing folder ", f->mrl() );
98
            m_ml->deleteFolder( *f );
99 100
            continue;
        }
101
        checkFolder( *folder, *f, false );
102
    }
103
    return true;
104 105
}

106
bool FsDiscoverer::reload( const std::string& entryPoint )
107
{
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
108
    if ( m_fsFactory->isMrlSupported( entryPoint ) == false )
109
        return false;
110
    LOG_INFO( "Reloading folder ", entryPoint );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
111
    auto folder = Folder::fromMrl( m_ml, entryPoint );
112 113 114
    if ( folder == nullptr )
    {
        LOG_ERROR( "Can't reload ", entryPoint, ": folder wasn't found in database" );
115
        return false;
116
    }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
117
    auto folderFs = m_fsFactory->createDirectory( folder->mrl() );
118 119
    if ( folderFs == nullptr )
    {
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
120
        LOG_ERROR(" Failed to create a fs::IDirectory representing ", folder->mrl() );
121
        return false;
122
    }
123
    checkFolder( *folderFs, *folder, false );
124
    return true;
125 126
}

127
void FsDiscoverer::checkFolder( fs::IDirectory& currentFolderFs, Folder& currentFolder, bool newFolder ) const
128
{
129 130 131 132 133 134
    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 ) )
        {
135 136 137 138 139
            if ( newFolder == false )
            {
                LOG_INFO( "Deleting folder ", currentFolderFs.mrl(), " due to a .nomedia file" );
                m_ml->deleteFolder( currentFolder );
            }
140 141 142 143 144 145 146
            return;
        }
    }
    // Only check once for a system_error. They are bound to happen when we list the files/folders
    // within, and hasDotMediaFile is the first place when this is done (except in case the root
    // entry point fails to be browsed, in which case the failure would happen before)
    catch ( std::system_error& ex )
147
    {
148 149 150 151 152 153
        LOG_WARN( "Failed to browse ", currentFolderFs.mrl(), ": ", ex.what() );
        if ( newFolder == false )
        {
            // If we ever came across this folder, its content is now unaccessible: let's remove it.
            m_ml->deleteFolder( currentFolder );
        }
154
        return;
155
    }
156

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
157
    m_cb->onDiscoveryProgress( currentFolderFs.mrl() );
158
    // Load the folders we already know of:
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
159
    LOG_INFO( "Checking for modifications in ", currentFolderFs.mrl() );
160 161 162
    // 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 )
163
        subFoldersInDB = currentFolder.folders();
164
    for ( const auto& subFolder : currentFolderFs.dirs() )
165
    {
166
        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
167
            return f->mrl() == subFolder->mrl();
168 169 170
        });
        // We don't know this folder, it's a new one
        if ( it == end( subFoldersInDB ) )
171
        {
172 173 174 175 176
            if ( hasDotNoMediaFile( *subFolder ) )
            {
                LOG_INFO( "Ignoring folder with a .nomedia file" );
                continue;
            }
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
177
            LOG_INFO( "New folder detected: ", subFolder->mrl() );
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
            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;
            }
196
        }
197
        auto folderInDb = *it;
198 199 200
        // 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
201
        checkFolder( *subFolder, *folderInDb, false );
202 203 204 205 206
        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
207
        LOG_INFO( "Folder ", f->mrl(), " not found in FS, deleting it" );
208
        m_ml->deleteFolder( *f );
209
    }
210
    checkFiles( currentFolderFs, currentFolder );
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
211
    LOG_INFO( "Done checking subfolders in ", currentFolderFs.mrl() );
212
}
213

214
void FsDiscoverer::checkFiles( fs::IDirectory& parentFolderFs, Folder& parentFolder ) const
215
{
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
216
    LOG_INFO( "Checking file in ", parentFolderFs.mrl() );
217
    static const std::string req = "SELECT * FROM " + policy::FileTable::Name
218
            + " WHERE folder_id = ?";
219
    auto files = File::fetchAll<File>( m_ml, req, parentFolder.id() );
220
    std::vector<std::shared_ptr<fs::IFile>> filesToAdd;
221
    std::vector<std::shared_ptr<File>> filesToRemove;
222
    for ( const auto& fileFs: parentFolderFs.files() )
223
    {
224
        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
225
            return f->mrl() == fileFs->mrl();
226 227 228
        });
        if ( it == end( files ) )
        {
229
            filesToAdd.push_back( std::move( fileFs ) );
230
            continue;
231
        }
232
        if ( fileFs->lastModificationDate() == (*it)->lastModificationDate() )
233
        {
234 235 236
            // Unchanged file
            files.erase( it );
            continue;
237
        }
238
        auto& file = (*it);
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
239
        LOG_INFO( "Forcing file refresh ", fileFs->mrl() );
240 241 242
        // 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();
243 244
        filesToRemove.push_back( std::move( file ) );
        filesToAdd.push_back( std::move( fileFs ) );
245 246
        files.erase( it );
    }
247
    auto t = m_ml->getConn()->newTransaction();
248 249
    for ( auto file : files )
    {
250
        LOG_INFO( "File ", file->mrl(), " not found on filesystem, deleting it" );
251 252 253 254 255 256 257 258 259 260
        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();
        }
261
    }
262 263 264 265
    for ( auto& f : filesToRemove )
        f->media()->removeFile( *f );
    // Insert all files at once to avoid SQL write contention
    for ( auto& p : filesToAdd )
266
        m_ml->addFile( *p, parentFolder, parentFolderFs );
267
    t->commit();
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
268
    LOG_INFO( "Done checking files in ", parentFolderFs.mrl() );
269
}
270

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

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

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
292
    auto f = Folder::create( m_ml, folder.mrl(),
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
}