MetadataParser.cpp 32.6 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 29 30 31
#include "MetadataParser.h"
#include "Album.h"
#include "AlbumTrack.h"
#include "Artist.h"
#include "File.h"
32 33 34
#include "filesystem/IDevice.h"
#include "filesystem/IDirectory.h"
#include "Folder.h"
35
#include "Genre.h"
36
#include "Media.h"
37
#include "Playlist.h"
38
#include "Show.h"
39
#include "utils/Directory.h"
40
#include "utils/Filename.h"
41
#include "utils/Url.h"
42
#include "utils/ModificationsNotifier.h"
43 44 45
#include "discoverer/FsDiscoverer.h"
#include "discoverer/probe/PathProbe.h"

46
#include <cstdlib>
47

48 49 50
namespace medialibrary
{

51
MetadataParser::MetadataParser()
52 53
    : m_ml( nullptr )
    , m_previousFolderId( 0 )
54 55 56
{
}

57
bool MetadataParser::cacheUnknownArtist()
58
{
59
    m_unknownArtist = Artist::fetch( m_ml, UnknownArtistID );
60 61 62 63 64
    if ( m_unknownArtist == nullptr )
        LOG_ERROR( "Failed to cache unknown artist" );
    return m_unknownArtist != nullptr;
}

65 66 67 68
bool MetadataParser::initialize( MediaLibrary* ml)
{
    m_ml = ml;
    m_notifier = ml->getNotifier();
69
    return cacheUnknownArtist();
70 71
}

72
int MetadataParser::toInt( parser::IItem& item, parser::IItem::Metadata meta )
73
{
74
    auto str = item.meta( meta );
75 76 77 78 79 80 81 82
    if ( str.empty() == false )
    {
        try
        {
            return std::stoi( str );
        }
        catch( std::logic_error& ex)
        {
83
            LOG_WARN( "Invalid meta #",
84
                      static_cast<typename std::underlying_type<parser::IItem::Metadata>::type>( meta ),
85
                      " provided (", str, "): ", ex.what() );
86 87 88 89 90
        }
    }
    return 0;
}

91
parser::Status MetadataParser::run( parser::IItem& item )
92
{
93
    bool alreadyInParser = false;
94
    int nbSubitem = item.nbSubItems();
95 96 97
    // Assume that file containing subitem(s) is a Playlist
    if ( nbSubitem > 0 )
    {
98
        auto res = addPlaylistMedias( item );
99
        if ( res == false ) // playlist addition may fail due to constraint violation
100
            return parser::Status::Fatal;
101

102
        assert( item.file() != nullptr );
103
        return parser::Status::Completed;
104 105
    }

106
    if ( item.file() == nullptr )
107
    {
108
        assert( item.media() == nullptr );
109
        // Try to create Media & File
110
        auto mrl = item.mrl();
111
        try
112
        {
113
            auto t = m_ml->getConn()->newTransaction();
114
            LOG_INFO( "Adding ", mrl );
115 116
            auto m = Media::create( m_ml, IMedia::Type::Unknown, utils::file::fileName( mrl ) );
            if ( m == nullptr )
117
            {
118
                LOG_ERROR( "Failed to add media ", mrl, " to the media library" );
119
                return parser::Status::Fatal;
120 121
            }
            // For now, assume all media are made of a single file
122 123 124
            auto file = m->addFile( *item.fileFs(),
                                    item.parentFolder()->id(),
                                    item.parentFolderFs()->device()->isRemovable(),
125 126
                                    File::Type::Main );
            if ( file == nullptr )
127
            {
128
                LOG_ERROR( "Failed to add file ", mrl, " to media #", m->id() );
129
                return parser::Status::Fatal;
130
            }
131
            item.setMedia( std::move( m ) );
132 133
            // Will invoke ITaskCb::updateFileId to upadte m_fileId & its
            // representation in DB
134
            item.setFile( std::move( file ) );
135
            t->commit();
136
        }
137 138
        // Voluntarily trigger an exception for a valid, but less common case, to avoid database overhead
        catch ( sqlite::errors::ConstraintViolation& ex )
139
        {
140 141 142
            LOG_INFO( "Creation of Media & File failed because ", ex.what(),
                      ". Assuming this task is a duplicate" );
            // Try to retrieve file & Media from database
143
            auto fileInDB = File::fromMrl( m_ml, mrl );
144 145
            if ( fileInDB == nullptr ) // The file is no longer present in DB, gracefully delete task
            {
146
                LOG_ERROR( "File ", mrl, " no longer present in DB, aborting");
147
                return parser::Status::Fatal;
148
            }
149 150
            auto media = fileInDB->media();
            if ( media == nullptr ) // Without a media, we cannot go further
151
                return parser::Status::Fatal;
152 153
            item.setFile( std::move( fileInDB ) );
            item.setMedia( std::move( media ) );
154

155
            alreadyInParser = true;
156
        }
157
    }
158
    else if ( item.media() == nullptr )
159 160 161 162 163 164
    {
        // If we have a file but no media, this is a problem, we can analyze as
        // much as we want, but won't be able to store anything.
        // Keep in mind that if we are in this code path, we are not analyzing
        // a playlist.
        assert( false );
165
        return parser::Status::Fatal;
166
    }
167

168 169
    if ( item.parentPlaylist() != nullptr )
        item.parentPlaylist()->add( item.media()->id(), item.parentPlaylistIndex() );
170 171

    if ( alreadyInParser == true )
172
        return parser::Status::Discarded;
173

174
    const auto& tracks = item.tracks();
175 176

    if ( tracks.empty() == true )
177
        return parser::Status::Fatal;
178

179
    bool isAudio = true;
180
    {
181
        using TracksT = decltype( tracks );
182
        sqlite::Tools::withRetries( 3, [this, &isAudio, &item]( TracksT tracks ) {
183
            auto t = m_ml->getConn()->newTransaction();
184
            for ( const auto& track : tracks )
185
            {
186
                if ( track.type == parser::IItem::Track::Type::Video )
187
                {
188
                    item.media()->addVideoTrack( track.codec, track.v.width, track.v.height,
189 190 191
                                          static_cast<float>( track.v.fpsNum ) /
                                              static_cast<float>( track.v.fpsDen ),
                                          track.language, track.description );
192 193
                    isAudio = false;
                }
194
                else
195
                {
196
                    assert( track.type == parser::IItem::Track::Type::Audio );
197
                    item.media()->addAudioTrack( track.codec, track.bitrate,
198 199
                                               track.a.rate, track.a.nbChannels,
                                               track.language, track.description );
200
                }
201
            }
202
            item.media()->setDuration( item.duration() );
203 204
            t->commit();
        }, std::move( tracks ) );
205 206 207
    }
    if ( isAudio == true )
    {
208
        if ( parseAudioFile( item ) == false )
209
            return parser::Status::Fatal;
210 211 212
    }
    else
    {
213
        if (parseVideoFile( item ) == false )
214
            return parser::Status::Fatal;
215
    }
216

217
    if ( item.file()->isDeleted() == true || item.media()->isDeleted() == true )
218
        return parser::Status::Fatal;
219

220
    m_notifier->notifyMediaCreation( item.media() );
221
    return parser::Status::Success;
222 223
}

224 225
/* Playlist files */

226
bool MetadataParser::addPlaylistMedias( parser::IItem& item ) const
227
{
228
    const auto& mrl = item.mrl();
229
    LOG_INFO( "Try to import ", mrl, " as a playlist" );
230
    std::shared_ptr<Playlist> playlistPtr;
231
    if ( item.file() != nullptr )
232
    {
233 234 235 236 237
        // We are most likely re-scanning a file representing a playlist.
        // If a task has a file, it means the playlist & the associated file have
        // been created.
        std::string req = "SELECT * FROM " + policy::PlaylistTable::Name +
                " WHERE file_id = ?";
238
        playlistPtr = Playlist::fetch( m_ml, req, item.file()->id() );
239 240 241 242 243 244 245
        if ( playlistPtr == nullptr )
        {
            // The playlist had to be created, something is very wrong, give up
            // FIXME: Check that the task will be deleted.
            assert( false );
            return false;
        }
246
    }
247
    else
248
    {
249
        auto playlistName = item.meta( parser::IItem::Metadata::Title );
250 251 252 253 254 255 256 257 258 259
        if ( playlistName.empty() == true )
            playlistName = utils::url::decode( utils::file::fileName( mrl ) );
        auto t = m_ml->getConn()->newTransaction();
        playlistPtr = Playlist::create( m_ml, playlistName );
        if ( playlistPtr == nullptr )
        {
            LOG_ERROR( "Failed to create playlist ", mrl, " to the media library" );
            return false;
        }

260 261 262
        auto file = playlistPtr->addFile( *item.fileFs(),
                                          item.parentFolder()->id(),
                                          item.parentFolderFs()->device()->isRemovable() );
263 264 265 266 267
        if ( file == nullptr )
        {
            LOG_ERROR( "Failed to add playlist file ", mrl );
            return false;
        }
268 269
        // Will invoke ITaskCb::updateFileId to upadte m_fileId & its
        // representation in DB
270
        item.setFile( std::move( file ) );
271
        t->commit();
272
    }
273 274 275 276 277
    // Now regardless of if the playlist is re-scanned or discovered from the
    // first time, just schedule all members for insertion. media & files will
    // be recreated if need be, and appropriate entries in PlaylistMediaRelation
    // table will be recreated to link things together.

278 279
    for ( auto i = 0u; i < item.nbSubItems(); ++i ) // FIXME: Interrupt loop if paused
        addPlaylistElement( item, playlistPtr, item.subItem( i ) );
280 281 282 283

    return true;
}

284
void MetadataParser::addPlaylistElement( parser::IItem& item,
285
                                         std::shared_ptr<Playlist> playlistPtr,
286
                                         const parser::IItem& subitem ) const
287
{
288
    const auto& mrl = subitem.mrl();
289
    LOG_INFO( "Try to add ", mrl, " to the playlist ", mrl );
290 291 292
    auto media = m_ml->media( mrl );
    if ( media != nullptr )
    {
293
        LOG_INFO( "Media for ", mrl, " already exists, adding it to the playlist ", mrl );
294
        playlistPtr->add( media->id(), subitem.parentPlaylistIndex() );
295 296 297 298 299 300 301 302 303
        return;
    }
    // Create Media, etc.
    auto fsFactory = m_ml->fsFactoryForMrl( mrl );

    if ( fsFactory == nullptr ) // Media not supported by any FsFactory, registering it as external
    {
        auto t2 = m_ml->getConn()->newTransaction();
        auto externalMedia = Media::create( m_ml, IMedia::Type::Unknown, utils::url::encode(
304
                subitem.meta( parser::IItem::Metadata::Title ) ) );
305 306
        if ( externalMedia == nullptr )
        {
307
            LOG_ERROR( "Failed to create external media for ", mrl, " in the playlist ", item.mrl() );
308 309 310 311 312
            return;
        }
        // Assuming that external mrl present in playlist file is a main media resource
        auto externalFile = externalMedia->addExternalMrl( mrl, IFile::Type::Main );
        if ( externalFile == nullptr )
313
            LOG_ERROR( "Failed to create external file for ", mrl, " in the playlist ", item.mrl() );
314
        playlistPtr->add( externalMedia->id(), subitem.parentPlaylistIndex() );
315 316 317 318 319 320 321 322 323 324 325 326 327
        t2->commit();
        return;
    }
    bool isDirectory;
    try
    {
        isDirectory = utils::fs::isDirectory( utils::file::toLocalPath( mrl ) );
    }
    catch ( std::system_error& ex )
    {
        LOG_ERROR( ex.what() );
        return;
    }
328
    LOG_INFO( "Importing ", isDirectory ? "folder " : "file ", mrl, " in the playlist ", item.mrl() );
329 330 331 332
    auto directoryMrl = utils::file::directory( mrl );
    auto parentFolder = Folder::fromMrl( m_ml, directoryMrl );
    bool parentKnown = parentFolder != nullptr;

333 334 335 336 337 338 339 340
    // The minimal entrypoint must be a device mountpoint
    auto device = fsFactory->createDeviceFromMrl( mrl );
    if ( device == nullptr )
    {
        LOG_ERROR( "Can't add a local folder with unknown storage device. ");
        return;
    }
    auto entryPoint = device->mountpoint();
341 342
    if ( parentKnown == false && Folder::fromMrl( m_ml, entryPoint ) != nullptr )
    {
343 344 345 346
        auto probePtr = std::unique_ptr<prober::PathProbe>(
                    new prober::PathProbe{ utils::file::stripScheme( mrl ),
                       isDirectory, std::move( playlistPtr ), parentFolder,
                       utils::file::stripScheme( directoryMrl ), subitem.parentPlaylistIndex(), true } );
347
        FsDiscoverer discoverer( fsFactory, m_ml, nullptr, std::move( probePtr ) );
348 349 350
        discoverer.reload( entryPoint );
        return;
    }
351 352 353 354
    auto probePtr = std::unique_ptr<prober::PathProbe>(
                new prober::PathProbe{ utils::file::stripScheme( mrl ),
                   isDirectory, std::move( playlistPtr ), parentFolder,
                   utils::file::stripScheme( directoryMrl ), subitem.parentPlaylistIndex(), false } );
355
    FsDiscoverer discoverer( fsFactory, m_ml, nullptr, std::move( probePtr ) );
356 357 358
    if ( parentKnown == false )
    {
        discoverer.discover( entryPoint );
359 360 361
        auto entryFolder = Folder::fromMrl( m_ml, entryPoint );
        if ( entryFolder != nullptr )
            Folder::excludeEntryFolder( m_ml, entryFolder->id() );
362 363 364 365 366
        return;
    }
    discoverer.reload( directoryMrl );
}

367 368
/* Video files */

369
bool MetadataParser::parseVideoFile( parser::IItem& item ) const
370
{
371
    auto media = item.media().get();
372
    media->setType( IMedia::Type::Video );
373
    const auto& title = item.meta( parser::IItem::Metadata::Title );
374
    if ( title.length() == 0 )
375
        return true;
376

377 378
    const auto& showName = item.meta( parser::IItem::Metadata::ShowName );
    const auto& artworkMrl = item.meta( parser::IItem::Metadata::ArtworkUrl );
379

380
    return sqlite::Tools::withRetries( 3, [this, &showName, &title, &item, &artworkMrl]() {
381
        auto t = m_ml->getConn()->newTransaction();
382
        item.media()->setTitleBuffered( title );
383

384
        if ( artworkMrl.empty() == false )
385
            item.media()->setThumbnail( artworkMrl, Thumbnail::Origin::Media );
386

387 388
        if ( showName.length() != 0 )
        {
389
            auto show = m_ml->show( showName );
390
            if ( show == nullptr )
391 392 393 394 395
            {
                show = m_ml->createShow( showName );
                if ( show == nullptr )
                    return false;
            }
396
            auto episode = toInt( item, parser::IItem::Metadata::Episode );
397 398 399
            if ( episode != 0 )
            {
                std::shared_ptr<Show> s = std::static_pointer_cast<Show>( show );
400
                s->addEpisode( *item.media(), title, episode );
401
            }
402 403 404 405 406
        }
        else
        {
            // How do we know if it's a movie or a random video?
        }
407
        item.media()->save();
408 409 410
        t->commit();
        return true;
    });
411 412 413 414 415
    return true;
}

/* Audio files */

416
bool MetadataParser::parseAudioFile( parser::IItem& item )
417
{
418
    item.media()->setType( IMedia::Type::Audio );
419

420
    auto artworkMrl = item.meta( parser::IItem::Metadata::ArtworkUrl );
421
    if ( artworkMrl.empty() == false )
422
    {
423
        item.media()->setThumbnail( artworkMrl, Thumbnail::Origin::Media );
424 425 426 427 428
        // Don't use an attachment as default artwork for album/artists
        if ( utils::file::schemeIs( "attachment", artworkMrl ) )
            artworkMrl.clear();
    }

429

430 431
    auto genre = handleGenre( item );
    auto artists = findOrCreateArtist( item );
432 433
    if ( artists.first == nullptr && artists.second == nullptr )
        return false;
434 435
    auto album = findAlbum( item, artists.first, artists.second );
    return sqlite::Tools::withRetries( 3, [this, &item, &artists]( std::string artworkMrl,
436 437
                                                  std::shared_ptr<Album> album, std::shared_ptr<Genre> genre ) {
        auto t = m_ml->getConn()->newTransaction();
438
        if ( album == nullptr )
439
        {
440
            const auto& albumName = item.meta( parser::IItem::Metadata::Album );
441 442 443 444 445 446 447 448 449
            int64_t thumbnailId = 0;
            if ( artworkMrl.empty() == false )
            {
                auto thumbnail = Thumbnail::create( m_ml, artworkMrl,
                                                    Thumbnail::Origin::Album );
                if ( thumbnail != nullptr )
                    thumbnailId = thumbnail->id();
            }
            album = m_ml->createAlbum( albumName, thumbnailId );
450 451 452 453 454
            if ( album == nullptr )
                return false;
            m_notifier->notifyAlbumCreation( album );
        }
        // If we know a track artist, specify it, otherwise, fallback to the album/unknown artist
455
        auto track = handleTrack( album, item, artists.second ? artists.second : artists.first,
456 457
                                  genre.get() );

458 459
        auto res = link( *item.media(), album, artists.first, artists.second );
        item.media()->save();
460 461 462
        t->commit();
        return res;
    }, std::move( artworkMrl ), std::move( album ), std::move( genre ) );
463 464
}

465
std::shared_ptr<Genre> MetadataParser::handleGenre( parser::IItem& item ) const
466
{
467
    const auto& genreStr = item.meta( parser::IItem::Metadata::Genre );
468
    if ( genreStr.length() == 0 )
469
        return nullptr;
470
    auto genre = Genre::fromName( m_ml, genreStr );
471 472
    if ( genre == nullptr )
    {
473
        genre = Genre::create( m_ml, genreStr );
474
        if ( genre == nullptr )
475
            LOG_ERROR( "Failed to get/create Genre", genreStr );
476 477 478 479
    }
    return genre;
}

480
/* Album handling */
481

482
std::shared_ptr<Album> MetadataParser::findAlbum( parser::IItem& item, std::shared_ptr<Artist> albumArtist,
483
                                                    std::shared_ptr<Artist> trackArtist )
484
{
485
    const auto& albumName = item.meta( parser::IItem::Metadata::Album );
486
    if ( albumName.empty() == true )
487
    {
488 489
        if ( albumArtist != nullptr )
            return albumArtist->unknownAlbum();
490
        if ( trackArtist != nullptr )
491 492
            return trackArtist->unknownAlbum();
        return m_unknownArtist->unknownAlbum();
493 494
    }

495
    if ( m_previousAlbum != nullptr && albumName == m_previousAlbum->title() &&
496
         m_previousFolderId != 0 && item.file()->folderId() == m_previousFolderId )
497 498 499 500
        return m_previousAlbum;
    m_previousAlbum.reset();
    m_previousFolderId = 0;

501 502
    // Album matching depends on the difference between artist & album artist.
    // Specificaly pass the albumArtist here.
503 504
    static const std::string req = "SELECT * FROM " + policy::AlbumTable::Name +
            " WHERE title = ?";
505
    auto albums = Album::fetchAll<Album>( m_ml, req, albumName );
506 507 508 509

    if ( albums.size() == 0 )
        return nullptr;

510 511
    const auto discTotal = toInt( item, parser::IItem::Metadata::DiscTotal );
    const auto discNumber = toInt( item, parser::IItem::Metadata::DiscNumber );
512 513 514 515 516
    /*
     * Even if we get only 1 album, we need to filter out invalid matches.
     * For instance, if we have already inserted an album "A" by an artist "john"
     * but we are now trying to handle an album "A" by an artist "doe", not filtering
     * candidates would yield the only "A" album we know, while we should return
517
     * nullptr, so the link() method can create a new one.
518 519 520 521
     */
    for ( auto it = begin( albums ); it != end( albums ); )
    {
        auto a = (*it).get();
522
        auto candidateAlbumArtist = a->albumArtist();
523 524 525 526
        // When we find an album, we will systematically assign an artist to it.
        // Not having an album artist (even it it's only a temporary one in the
        // case of a compilation album) is not expected at all.
        assert( candidateAlbumArtist != nullptr );
527 528 529 530
        if ( albumArtist != nullptr )
        {
            // We assume that an album without album artist is a positive match.
            // At the end of the day, without proper tags, there's only so much we can do.
531
            if ( candidateAlbumArtist->id() != albumArtist->id() )
532 533 534 535 536 537 538 539 540 541 542
            {
                it = albums.erase( it );
                continue;
            }
        }
        // If this is a multidisc album, assume it could be in a multiple amount of folders.
        // Since folders can come in any order, we can't assume the first album will be the
        // first media we see. If the discTotal or discNumber meta are provided, that's easy. If not,
        // we assume that another CD with the same name & artists, and a disc number > 1
        // denotes a multi disc album
        // Check the first case early to avoid fetching tracks if unrequired.
543
        if ( discTotal > 1 || discNumber > 1 )
544 545 546 547
        {
            ++it;
            continue;
        }
548
        const auto tracks = a->cachedTracks();
549 550 551 552 553 554 555
        // If there is no tracks to compare with, we just have to hope this will be the only valid
        // album match
        if ( tracks.size() == 0 )
        {
            ++it;
            continue;
        }
556 557

        auto multiDisc = false;
558 559
        auto multipleArtists = false;
        int64_t previousArtistId = trackArtist != nullptr ? trackArtist->id() : 0;
560 561 562 563
        for ( auto& t : tracks )
        {
            auto at = t->albumTrack();
            assert( at != nullptr );
564 565 566
            if ( at == nullptr )
                continue;
            if ( at->discNumber() > 1 )
567
                multiDisc = true;
568 569 570 571 572
            if ( previousArtistId != 0 && previousArtistId != at->artist()->id() )
                multipleArtists = true;
            previousArtistId = at->artist()->id();
            // We now know enough about the album, we can stop looking at its tracks
            if ( multiDisc == true && multipleArtists == true )
573 574 575 576 577 578 579 580
                break;
        }
        if ( multiDisc )
        {
            ++it;
            continue;
        }

581
        // Assume album files will be in the same folder.
582
        auto newFileFolder = utils::file::directory( item.file()->mrl() );
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
        auto trackFiles = tracks[0]->files();
        bool differentFolder = false;
        for ( auto& f : trackFiles )
        {
            auto candidateFolder = utils::file::directory( f->mrl() );
            if ( candidateFolder != newFileFolder )
            {
                differentFolder = true;
                break;
            }
        }
        // We now have a candidate by the same artist in the same folder, assume it to be
        // a positive match.
        if ( differentFolder == false )
        {
            ++it;
            continue;
        }

602 603 604 605
        // Attempt to discriminate by date, but only for the same artists.
        // Not taking the artist in consideration would cause compilation to
        // create multiple albums, especially when track are only partially
        // tagged with a year.
606
        if ( multipleArtists == false )
607
        {
608
            auto candidateDate = item.meta( parser::IItem::Metadata::Date );
609
            if ( candidateDate.empty() == false )
610
            {
611 612 613 614 615 616 617 618 619 620 621 622 623
                try
                {
                    unsigned int year = std::stoi( candidateDate );
                    if ( year != a->releaseYear() )
                        it = albums.erase( it );
                    else
                        ++it;
                    continue;
                }
                catch (...)
                {
                    // Date wasn't helpful, simply ignore the error and continue
                }
624 625
            }
        }
626 627 628 629 630 631 632 633 634
        // The candidate is :
        // - in a different folder
        // - not a multidisc album
        // - Either:
        //      - from the same artist & without a date to discriminate
        //      - from the same artist & with a different date
        //      - from different artists
        // Assume it's a negative match.
        it = albums.erase( it );
635 636 637 638 639
    }
    if ( albums.size() == 0 )
        return nullptr;
    if ( albums.size() > 1 )
    {
640
        LOG_WARN( "Multiple candidates for album ", albumName, ". Selecting first one out of luck" );
641
    }
642
    m_previousFolderId = item.file()->folderId();
643 644
    m_previousAlbum = albums[0];
    return albums[0];
645 646 647 648
}

///
/// \brief MetadataParser::handleArtists Returns Artist's involved on a track
649
/// \param task The current parser task
650 651 652 653
/// \return A pair containing:
/// The album artist as a first element
/// The track artist as a second element, or nullptr if it is the same as album artist
///
654
std::pair<std::shared_ptr<Artist>, std::shared_ptr<Artist>> MetadataParser::findOrCreateArtist( parser::IItem& item ) const
655 656 657
{
    std::shared_ptr<Artist> albumArtist;
    std::shared_ptr<Artist> artist;
658
    static const std::string req = "SELECT * FROM " + policy::ArtistTable::Name + " WHERE name = ?";
659

660 661
    const auto& albumArtistStr = item.meta( parser::IItem::Metadata::AlbumArtist );
    const auto& artistStr = item.meta( parser::IItem::Metadata::Artist );
662
    if ( albumArtistStr.empty() == true && artistStr.empty() == true )
663
    {
664
        return {m_unknownArtist, m_unknownArtist};
665 666
    }

667
    if ( albumArtistStr.empty() == false )
668
    {
669
        albumArtist = Artist::fetch( m_ml, req, albumArtistStr );
670 671
        if ( albumArtist == nullptr )
        {
672
            albumArtist = m_ml->createArtist( albumArtistStr );
673 674
            if ( albumArtist == nullptr )
            {
675
                LOG_ERROR( "Failed to create new artist ", albumArtistStr );
676 677
                return {nullptr, nullptr};
            }
678
            m_notifier->notifyArtistCreation( albumArtist );
679 680
        }
    }
681
    if ( artistStr.empty() == false && artistStr != albumArtistStr )
682
    {
683
        artist = Artist::fetch( m_ml, req, artistStr );
684 685
        if ( artist == nullptr )
        {
686
            artist = m_ml->createArtist( artistStr );
687 688
            if ( artist == nullptr )
            {
689
                LOG_ERROR( "Failed to create new artist ", artistStr );
690 691
                return {nullptr, nullptr};
            }
692
            m_notifier->notifyArtistCreation( artist );
693 694 695 696 697 698 699
        }
    }
    return {albumArtist, artist};
}

/* Tracks handling */

700
std::shared_ptr<AlbumTrack> MetadataParser::handleTrack( std::shared_ptr<Album> album, parser::IItem& item,
701
                                                         std::shared_ptr<Artist> artist, Genre* genre ) const
702
{
703 704
    assert( sqlite::Transaction::transactionInProgress() == true );

705 706 707
    auto title = item.meta( parser::IItem::Metadata::Title );
    const auto trackNumber = toInt( item, parser::IItem::Metadata::TrackNumber );
    const auto discNumber = toInt( item, parser::IItem::Metadata::DiscNumber );
708 709 710
    if ( title.empty() == true )
    {
        LOG_WARN( "Failed to get track title" );
711
        if ( trackNumber != 0 )
712 713
        {
            title = "Track #";
714
            title += std::to_string( trackNumber );
715 716 717
        }
    }
    if ( title.empty() == false )
718
        item.media()->setTitleBuffered( title );
719

720
    auto track = std::static_pointer_cast<AlbumTrack>( album->addTrack( item.media(), trackNumber,
721
                                                                        discNumber, artist->id(),
722
                                                                        genre ) );
723 724 725 726 727
    if ( track == nullptr )
    {
        LOG_ERROR( "Failed to create album track" );
        return nullptr;
    }
728

729
    const auto& releaseDate = item.meta( parser::IItem::Metadata::Date );
730
    if ( releaseDate.empty() == false )
731
    {
732
        auto releaseYear = atoi( releaseDate.c_str() );
733
        item.media()->setReleaseDate( releaseYear );
734 735 736 737 738
        // Let the album handle multiple dates. In order to do this properly, we need
        // to know if the date has been changed before, which can be known only by
        // using Album class internals.
        album->setReleaseYear( releaseYear, false );
    }
739
    m_notifier->notifyAlbumTrackCreation( track );
740 741 742 743 744 745
    return track;
}

/* Misc */

bool MetadataParser::link( Media& media, std::shared_ptr<Album> album,
746
                               std::shared_ptr<Artist> albumArtist, std::shared_ptr<Artist> artist )
747
{
748
    if ( albumArtist == nullptr )
749 750
    {
        assert( artist != nullptr );
751
        albumArtist = artist;
752
    }
753
    assert( album != nullptr );
754

755 756
    auto albumThumbnail = album->thumbnail();

757 758 759 760
    // We might modify albumArtist later, hence handle thumbnails before.
    // If we have an albumArtist (meaning the track was properly tagged, we
    // can assume this artist is a correct match. We can use the thumbnail from
    // the current album for the albumArtist, if none has been set before.
761 762 763 764
    // Although we don't want to do this for unknown/various artists, as the
    // thumbnail wouldn't reflect those "special" artists
    if ( albumArtist != nullptr && albumArtist->id() != UnknownArtistID &&
         albumArtist->id() != VariousArtistID &&
765 766 767 768 769 770 771 772 773 774 775 776 777 778
         albumThumbnail != nullptr )
    {
        auto albumArtistThumbnail = albumArtist->thumbnail();
        // If the album artist has no thumbnail, let's assign it
        if ( albumArtistThumbnail == nullptr )
        {
            albumArtist->setArtworkMrl( albumThumbnail->mrl(), Thumbnail::Origin::AlbumArtist );
        }
        else if ( albumArtistThumbnail->origin() == Thumbnail::Origin::Artist )
        {
            // We only want to change the thumbnail if it was assigned from an
            // album this artist was only featuring on
        }
    }
779

780 781 782 783
    // Until we have a better artwork extraction/assignation, simply do the same
    // for artists
    if ( artist != nullptr && artist->id() != UnknownArtistID &&
         artist->id() != VariousArtistID &&
784 785 786 787
         albumThumbnail != nullptr && artist->thumbnail() == nullptr )
    {
        artist->setArtworkMrl( album->artworkMrl(), Thumbnail::Origin::Artist );
    }
788

789 790 791 792 793 794 795 796 797 798 799 800 801
    if ( albumArtist != nullptr )
        albumArtist->addMedia( media );
    if ( artist != nullptr && ( albumArtist == nullptr || albumArtist->id() != artist->id() ) )
        artist->addMedia( media );

    auto currentAlbumArtist = album->albumArtist();

    // If we have no main artist yet, that's easy, we need to assign one.
    if ( currentAlbumArtist == nullptr )
    {
        // We don't know if the artist was tagged as artist or albumartist, however, we simply add it
        // as the albumartist until proven we were wrong (ie. until one of the next tracks
        // has a different artist)
802
        album->setAlbumArtist( albumArtist );
803 804
        // Always add the album artist as an artist
        album->addArtist( albumArtist );
805 806 807
        // Always update the album artist number of tracks.
        // The artist might be different, and will be handled a few lines below
        albumArtist->updateNbTrack( 1 );
808
        if ( artist != nullptr )
809 810 811 812 813
        {
            // If the album artist is not the artist, we need to update the
            // album artist track count as well.
            if ( albumArtist->id() != artist->id() )
                artist->updateNbTrack( 1 );
814
            album->addArtist( artist );
815
        }
816 817 818
    }
    else
    {
819
        // We have more than a single artist on this album, fallback to various artists
820 821
        if ( albumArtist->id() != currentAlbumArtist->id() )
        {
822 823
            if ( m_variousArtists == nullptr )
                m_variousArtists = Artist::fetch( m_ml, VariousArtistID );
824 825 826 827 828 829 830 831 832 833 834 835 836 837
            // If we already switched to various artist, no need to do it again
            if ( m_variousArtists->id() != currentAlbumArtist->id() )
            {
                // All tracks from this album must now also be reflected in various
                // artist number of tracks
                m_variousArtists->updateNbTrack( album->nbTracks() );
                album->setAlbumArtist( m_variousArtists );
            }
            // However we always need to bump the various artist number of tracks
            else
            {
                m_variousArtists->updateNbTrack( 1 );
            }
            // Add this artist as "featuring".
838 839 840 841
            album->addArtist( albumArtist );
        }
        if ( artist != nullptr && artist->id() != albumArtist->id() )
        {
842 843
           album->addArtist( artist );
           artist->updateNbTrack( 1 );
844
        }
845
        albumArtist->updateNbTrack( 1 );
846 847 848 849 850 851 852 853 854
    }

    return true;
}

const char* MetadataParser::name() const
{
    return "Metadata";
}
855 856 857 858 859 860 861 862 863 864

uint8_t MetadataParser::nbThreads() const
{
//    auto nbProcs = std::thread::hardware_concurrency();
//    if ( nbProcs == 0 )
//        return 1;
//    return nbProcs;
    // Let's make this code thread-safe first :)
    return 1;
}
865

866
void MetadataParser::onFlushing()
867 868 869 870 871 872
{
    m_variousArtists = nullptr;
    m_previousAlbum = nullptr;
    m_previousFolderId = 0;
}

873
void MetadataParser::onRestarted()
874 875
{
    // Reset locally cached entities
876
    cacheUnknownArtist();
877 878
}

879
parser::Step MetadataParser::targetedStep() const
880
{
881
    return parser::Step::MetadataAnalysis;
882 883
}

884
}