digiKam
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
Digikam::CollectionScanner Class Reference
+ Inheritance diagram for Digikam::CollectionScanner:

Classes

class  Private
 

Public Types

enum  FileScanMode { NormalScan , ModifiedScan , Rescan }
 

Public Member Functions

 CollectionScanner ()
 
QStringList deferredAlbumPaths () const
 
QList< qlonglong > getNewIdsList () const
 
void setDeferredFileScanning (bool defer)
 
void setHintContainer (CollectionScannerHintContainer *const container)
 
void setNeedFileCount (bool on)
 
void setObserver (CollectionScannerObserver *const observer)
 
void setPerformFastScan (bool on)
 
void setSignalsEnabled (bool on)
 
void setUpdateHashHint (bool hint=true)
 
 ~CollectionScanner () override
 

Static Public Member Functions

static CollectionScannerHintContainer * createHintContainer ()
 

Scan utilities

void safelyRemoveAlbums (const QList< int > &albumIds)
 
static void copyFileProperties (const ItemInfo &source, const ItemInfo &dest)
 
void markDatabaseAsScanned ()
 
void mainEntryPoint (bool complete)
 
int checkAlbum (const CollectionLocation &location, const QString &album)
 
void itemsWereRemoved (const QList< qlonglong > &removedIds)
 
void updateRemovedItemsTime ()
 
void incrementDeleteRemovedCompleteScanCount ()
 
void resetDeleteRemovedSettings ()
 
bool checkDeleteRemoved ()
 
void loadNameFilters ()
 
int countItemsInFolder (const QString &path)
 
DatabaseItem::Category category (const QFileInfo &info)
 
void totalFilesToScan (int count)
 
void startScanningAlbumRoot (const QString &albumRoot)
 
void startScanningAlbum (const QString &albumRoot, const QString &album)
 
void startScanningForStaleAlbums ()
 
void startScanningAlbumRoots ()
 
void startCompleteScan ()
 
void signalScannedNewImage (const QFileInfo &info)
 
void finishedScanningAlbumRoot (const QString &albumRoot)
 
void finishedScanningAlbum (const QString &albumRoot, const QString &album, int filesScanned)
 
void finishedScanningForStaleAlbums ()
 
void finishedCompleteScan ()
 
void scannedFiles (int filesScanned)
 
void cancelled ()
 

Scan operations

void completeScan ()
 
void finishCompleteScan (const QStringList &albumPaths)
 
void partialScan (const QString &filePath)
 
void partialScan (const QString &albumRoot, const QString &album)
 
qlonglong scanFile (const QString &filePath, FileScanMode mode=ModifiedScan)
 
qlonglong scanFile (const QString &albumRoot, const QString &album, const QString &fileName, FileScanMode mode=ModifiedScan)
 
void scanFile (const ItemInfo &info, FileScanMode mode=ModifiedScan)
 
static bool databaseInitialScanDone ()
 
void scanForStaleAlbums (const QList< CollectionLocation > &locations)
 
void scanForStaleAlbums (const QList< int > &locationIdsToScan)
 
void scanAlbumRoot (const CollectionLocation &location)
 
void scanAlbum (const CollectionLocation &location, const QString &album, bool checkDate=false)
 
void scanExistingFile (const QFileInfo &fi, qlonglong id)
 
void scanFileNormal (const QFileInfo &info, const ItemScanInfo &scanInfo, bool checkSidecar=true)
 
void scanModifiedFile (const QFileInfo &info, const ItemScanInfo &scanInfo)
 
void scanFileUpdateHashReuseThumbnail (const QFileInfo &fi, const ItemScanInfo &scanInfo, bool fileWasEdited)
 
void rescanFile (const QFileInfo &info, const ItemScanInfo &scanInfo)
 
void completeScanCleanupPart ()
 
void completeHistoryScanning ()
 
void finishHistoryScanning ()
 
void historyScanningStage2 (const QList< qlonglong > &ids)
 
void historyScanningStage3 (const QList< qlonglong > &ids)
 
qlonglong scanFile (const QFileInfo &fi, int albumId, qlonglong id, FileScanMode mode)
 
qlonglong scanNewFile (const QFileInfo &info, int albumId)
 
qlonglong scanNewFileFullScan (const QFileInfo &info, int albumId)
 

Member Enumeration Documentation

◆ FileScanMode

enum Digikam::CollectionScanner::FileScanMode
Enumerator
NormalScan 

The file will be scanned like it is done for any usual scan. If it was not modified, no further action is taken. If the file is not known yet, it will be fully scanned, or, if an identical file is found, this data will be copied.

ModifiedScan 

The file will scanned like a modified file. Only a selected portion of the metadata will be updated into the database. If the file is not known yet, it will be fully scanned, or, if an identical file is found, this data will be copied.

Rescan 

The file will be scanned like a completely new file. The complete metadata is re-read into the database. No search for identical files will be done.

Constructor & Destructor Documentation

◆ CollectionScanner()

Digikam::CollectionScanner::CollectionScanner ( )
explicit

◆ ~CollectionScanner()

Digikam::CollectionScanner::~CollectionScanner ( )
override

Member Function Documentation

◆ cancelled

void Digikam::CollectionScanner::cancelled ( )
signal

Emitted when the observer told to cancel the scan

Referenced by completeScan(), finishCompleteScan(), and partialScan().

◆ category()

DatabaseItem::Category Digikam::CollectionScanner::category ( const QFileInfo &  info)
protected

References Digikam::DatabaseItem::Audio, Digikam::CollectionScanner::Private::audioFilterSet, Digikam::DatabaseItem::Image, Digikam::CollectionScanner::Private::imageFilterSet, Digikam::DatabaseItem::Other, suffix, Digikam::DatabaseItem::Video, and Digikam::CollectionScanner::Private::videoFilterSet.

Referenced by rescanFile(), scanFileUpdateHashReuseThumbnail(), scanModifiedFile(), scanNewFile(), and scanNewFileFullScan().

◆ checkAlbum()

int Digikam::CollectionScanner::checkAlbum ( const CollectionLocation &  location,
const QString &  album 
)
protected

References Digikam::CoreDB::addAlbum(), Digikam::CollectionScannerHintContainerImplementation::albumHints, Digikam::CollectionScannerHints::Album::albumId, Digikam::CoreDB::copyAlbumProperties(), Digikam::CoreDbAccess::db(), Digikam::CollectionScanner::Private::establishedSourceAlbums, Digikam::CoreDB::getAlbumForPath(), Digikam::CollectionScanner::Private::hints, Digikam::CollectionScannerHints::Album::isNull(), Digikam::RedEye::location(), and Digikam::CollectionScannerHintContainerImplementation::lock.

Referenced by scanAlbum(), and scanFile().

◆ checkDeleteRemoved()

bool Digikam::CollectionScanner::checkDeleteRemoved ( )
protected

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::getSetting().

Referenced by completeScanCleanupPart().

◆ completeHistoryScanning()

void Digikam::CollectionScanner::completeHistoryScanning ( )
protected

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemIDsInTag(), Digikam::TagsCache::getOrCreateInternalTag(), historyScanningStage2(), historyScanningStage3(), Digikam::TagsCache::instance(), Digikam::InternalTagName::needResolvingHistory(), and Digikam::InternalTagName::needTaggingHistoryGraph().

Referenced by completeScanCleanupPart().

◆ completeScan()

void Digikam::CollectionScanner::completeScan ( )

Carries out a full scan on all available parts of the collection. Only a full scan can finally remove deleted files from the database, only a full scan will mark the database as scanned. The database will be locked while running (Note: this is not done for partialScans).

References Digikam::CollectionManager::allAvailableLocations(), cancelled(), Digikam::CollectionScanner::Private::checkObserver(), completeScanCleanupPart(), countItemsInFolder(), Digikam::CoreDbAccess::db(), Digikam::CollectionScanner::Private::deferredFileScanning, Digikam::CoreDB::deleteStaleAlbums(), finishedCompleteScan(), Digikam::CollectionScannerHintContainerImplementation::hasAlbumHints(), Digikam::CollectionScanner::Private::hints, Digikam::CollectionManager::instance(), Digikam::RedEye::location(), mainEntryPoint(), Digikam::CollectionScanner::Private::needTotalFiles, Digikam::CollectionScanner::Private::resetRemovedItemsTime(), scanAlbumRoot(), scanForStaleAlbums(), startCompleteScan(), startScanningAlbumRoots(), totalFilesToScan(), and Digikam::CollectionScanner::Private::wantSignals.

Referenced by Digikam::ScanController::run(), and Digikam::CoreDbSchemaUpdater::updateUniqueHash().

◆ completeScanCleanupPart()

void Digikam::CollectionScanner::completeScanCleanupPart ( )
protected

References checkDeleteRemoved(), completeHistoryScanning(), Digikam::CoreDbAccess::db(), finishedCompleteScan(), Digikam::CoreDB::getImageIds(), incrementDeleteRemovedCompleteScanCount(), markDatabaseAsScanned(), Digikam::DatabaseItem::Obsolete, resetDeleteRemovedSettings(), Digikam::CoreDB::setItemStatus(), Digikam::DatabaseItem::Trashed, and updateRemovedItemsTime().

Referenced by completeScan(), and finishCompleteScan().

◆ copyFileProperties()

void Digikam::CollectionScanner::copyFileProperties ( const ItemInfo &  source,
const ItemInfo &  dest 
)
static

When a file is derived from another file, typically through editing, copy all relevant attributes from source file to the new file.

References Digikam::CoreDB::addItemPosition(), Digikam::ItemComments::apply(), Digikam::CoreDB::changeItemInformation(), Digikam::ItemInfo::colorLabel(), Digikam::CoreDB::copyImageProperties(), Digikam::DatabaseFields::CreationDate, Digikam::CoreDbAccess::db(), Digikam::DatabaseFields::DigitizationDate, Digikam::CoreDB::getItemInformation(), Digikam::CoreDB::getItemPosition(), Digikam::ItemInfo::id(), Digikam::TagsCache::instance(), Digikam::ItemInfo::isNull(), Digikam::DatabaseFields::ItemPositionsAll, Digikam::ItemInfo::pickLabel(), Digikam::DatabaseFields::Rating, Digikam::ItemComments::replaceFrom(), Digikam::ItemCopyright::replaceFrom(), Digikam::ItemInfo::setColorLabel(), Digikam::ItemInfo::setPickLabel(), Digikam::ItemInfo::setTag(), and Digikam::ItemInfo::tagIds().

Referenced by Digikam::FileActionMngrDatabaseWorker::copyAttributes().

◆ countItemsInFolder()

int Digikam::CollectionScanner::countItemsInFolder ( const QString &  path)
protected

References Digikam::CollectionManager::album(), Digikam::CoreDbAccess::db(), Digikam::DeleteDialogMode::Files, Digikam::CoreDB::getAlbumForPath(), Digikam::CollectionManager::instance(), Digikam::RedEye::location(), and Digikam::CollectionManager::locationForPath().

Referenced by completeScan(), and finishCompleteScan().

◆ createHintContainer()

CollectionScannerHintContainer * Digikam::CollectionScanner::createHintContainer ( )
static

Hints give the scanner additional info about things that happened in the past carried out by higher level which the collection scanner cannot know. They allow to carry out optimizations. Record hints in a container, and provide the container to the collection scanner. The Container set in setHintContainer must be one created by createContainer.

◆ databaseInitialScanDone()

bool Digikam::CollectionScanner::databaseInitialScanDone ( )
static

Returns if the initial scan of the database has been done. This is the first complete scan after creation of a new database file (or update requiring a rescan)

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::getSetting().

Referenced by Digikam::ScanController::completeCollectionScan(), Digikam::DigikamApp::DigikamApp(), and Digikam::DigikamApp::show().

◆ deferredAlbumPaths()

QStringList Digikam::CollectionScanner::deferredAlbumPaths ( ) const

References Digikam::CollectionScanner::Private::deferredAlbumPaths.

Referenced by Digikam::CollectionScanner::Private::checkDeferred(), and Digikam::ScanController::run().

◆ finishCompleteScan()

void Digikam::CollectionScanner::finishCompleteScan ( const QStringList &  albumPaths)

If you enable deferred file scanning for a completeScan(), new files will not be scanned. The relevant albums are available from deferredAlbumPaths() when completeScan() has finished. You need to call finishCompleteScan() afterwards with the list to get the same complete scan than undeferred completeScan().

References Digikam::CollectionManager::album(), cancelled(), Digikam::CollectionScanner::Private::checkObserver(), completeScanCleanupPart(), countItemsInFolder(), Digikam::CollectionManager::instance(), Digikam::RedEye::location(), Digikam::CollectionManager::locationForPath(), mainEntryPoint(), Digikam::CollectionScanner::Private::needTotalFiles, Digikam::CollectionScanner::Private::resetRemovedItemsTime(), scanAlbum(), scanAlbumRoot(), startCompleteScan(), startScanningAlbumRoots(), totalFilesToScan(), and Digikam::CollectionScanner::Private::wantSignals.

Referenced by Digikam::ScanController::run().

◆ finishedCompleteScan

void Digikam::CollectionScanner::finishedCompleteScan ( )
signal

Referenced by completeScan(), and completeScanCleanupPart().

◆ finishedScanningAlbum

void Digikam::CollectionScanner::finishedScanningAlbum ( const QString &  albumRoot,
const QString &  album,
int  filesScanned 
)
signal

Referenced by scanAlbum().

◆ finishedScanningAlbumRoot

void Digikam::CollectionScanner::finishedScanningAlbumRoot ( const QString &  albumRoot)
signal

Emitted when the scanning has finished. Note that start/finishScanningAlbum may be emitted recursively.

Referenced by scanAlbumRoot().

◆ finishedScanningForStaleAlbums

void Digikam::CollectionScanner::finishedScanningForStaleAlbums ( )
signal

Referenced by scanForStaleAlbums().

◆ finishHistoryScanning()

void Digikam::CollectionScanner::finishHistoryScanning ( )
protected

References Digikam::CollectionScanner::Private::checkObserver(), historyScanningStage2(), historyScanningStage3(), Digikam::CollectionScanner::Private::needResolveHistorySet, and Digikam::CollectionScanner::Private::needTaggingHistorySet.

Referenced by partialScan(), and scanFile().

◆ getNewIdsList()

QList< qlonglong > Digikam::CollectionScanner::getNewIdsList ( ) const

Returns item ids from new detected items

References Digikam::CollectionScanner::Private::newIdsList.

Referenced by Digikam::ScanController::run().

◆ historyScanningStage2()

void Digikam::CollectionScanner::historyScanningStage2 ( const QList< qlonglong > &  ids)
protected

References Digikam::CollectionScanner::Private::checkObserver(), Digikam::CollectionScanner::Private::needTaggingHistorySet, Digikam::CollectionScanner::Private::recordHistoryIds, and Digikam::ItemScanner::resolveImageHistory().

Referenced by completeHistoryScanning(), and finishHistoryScanning().

◆ historyScanningStage3()

void Digikam::CollectionScanner::historyScanningStage3 ( const QList< qlonglong > &  ids)
protected

References Digikam::CollectionScanner::Private::checkObserver(), and Digikam::ItemScanner::tagItemHistoryGraph().

Referenced by completeHistoryScanning(), and finishHistoryScanning().

◆ incrementDeleteRemovedCompleteScanCount()

void Digikam::CollectionScanner::incrementDeleteRemovedCompleteScanCount ( )
protected

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getSetting(), and Digikam::CoreDB::setSetting().

Referenced by completeScanCleanupPart().

◆ itemsWereRemoved()

void Digikam::CollectionScanner::itemsWereRemoved ( const QList< qlonglong > &  removedIds)
protected

References Digikam::CoreDB::addTagsToItems(), Digikam::CoreDbAccess::db(), Digikam::DatabaseRelation::DerivedFrom, Digikam::CoreDB::getOneRelatedImageEach(), Digikam::TagsCache::getOrCreateInternalTag(), Digikam::TagsCache::instance(), Digikam::InternalTagName::needTaggingHistoryGraph(), Digikam::CollectionScanner::Private::needTaggingHistorySet, Digikam::CollectionScanner::Private::recordHistoryIds, and Digikam::CollectionScanner::Private::removedItems().

Referenced by safelyRemoveAlbums(), and scanAlbum().

◆ loadNameFilters()

void Digikam::CollectionScanner::loadNameFilters ( )
protected

References Digikam::CollectionScanner::Private::audioFilterSet, Digikam::CoreDbAccess::db(), Digikam::CoreDB::getFilterSettings(), Digikam::CoreDB::getIgnoreDirectoryFilterSettings(), Digikam::CollectionScanner::Private::ignoreDirectory, Digikam::CollectionScanner::Private::imageFilterSet, Digikam::CollectionScanner::Private::nameFilters, and Digikam::CollectionScanner::Private::videoFilterSet.

Referenced by mainEntryPoint().

◆ mainEntryPoint()

void Digikam::CollectionScanner::mainEntryPoint ( bool  complete)
protected

References loadNameFilters(), and Digikam::CollectionScanner::Private::recordHistoryIds.

Referenced by completeScan(), finishCompleteScan(), partialScan(), and scanFile().

◆ markDatabaseAsScanned()

void Digikam::CollectionScanner::markDatabaseAsScanned ( )
protected

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::setSetting().

Referenced by completeScanCleanupPart().

◆ partialScan() [1/2]

void Digikam::CollectionScanner::partialScan ( const QString &  albumRoot,
const QString &  album 
)

Same procedure as above, but albumRoot and album is provided.

References Digikam::CollectionScannerHintContainerImplementation::albumHints, cancelled(), Digikam::CollectionScanner::Private::checkObserver(), Digikam::CoreDbAccess::db(), Digikam::CoreDB::deleteStaleAlbums(), finishHistoryScanning(), Digikam::CollectionScannerHintContainerImplementation::hasAlbumHints(), Digikam::CollectionScanner::Private::hints, Digikam::CollectionManager::instance(), Digikam::RedEye::location(), Digikam::CollectionManager::locationForAlbumRootPath(), Digikam::CollectionScannerHintContainerImplementation::lock, mainEntryPoint(), Digikam::CollectionScanner::Private::resetRemovedItemsTime(), scanAlbum(), scanAlbumRoot(), scanForStaleAlbums(), and updateRemovedItemsTime().

◆ partialScan() [2/2]

void Digikam::CollectionScanner::partialScan ( const QString &  filePath)

Carries out a partial scan on the specified path of the collection. The includes scanning for new files + albums and updating modified file data. Files no longer found in the specified path however are not completely removed, but only marked as removed. They will be removed only after a complete scan.

References Digikam::CollectionManager::album(), Digikam::CollectionManager::albumRootPath(), and Digikam::CollectionManager::instance().

Referenced by Digikam::ScanController::run().

◆ rescanFile()

void Digikam::CollectionScanner::rescanFile ( const QFileInfo &  info,
const ItemScanInfo &  scanInfo 
)
protected

References category(), Digikam::CollectionScanner::Private::checkDeferred(), Digikam::CollectionScanner::Private::finishScanner(), Digikam::ItemScanner::rescan(), and Digikam::ItemScanner::setCategory().

Referenced by scanFile(), and scanFileNormal().

◆ resetDeleteRemovedSettings()

void Digikam::CollectionScanner::resetDeleteRemovedSettings ( )
protected

References Digikam::CoreDbAccess::db(), and Digikam::CoreDB::setSetting().

Referenced by completeScanCleanupPart().

◆ safelyRemoveAlbums()

void Digikam::CollectionScanner::safelyRemoveAlbums ( const QList< int > &  albumIds)

Prepare the given albums to be removed, typically by setting the albums as orphan and removing all entries from the albums

References Digikam::CoreDbAccess::db(), Digikam::CoreDB::getItemIDsInAlbum(), itemsWereRemoved(), Digikam::CoreDB::makeStaleAlbum(), and Digikam::CoreDB::removeItemsFromAlbum().

Referenced by Digikam::CollectionManager::removeLocation(), and scanForStaleAlbums().

◆ scanAlbum()

void Digikam::CollectionScanner::scanAlbum ( const CollectionLocation &  location,
const QString &  album,
bool  checkDate = false 
)
protected

References checkAlbum(), Digikam::CollectionScanner::Private::checkObserver(), Digikam::ItemInfo::dateTime(), Digikam::CoreDbAccess::db(), Digikam::CollectionScanner::Private::deferredFileScanning, Digikam::DeleteDialogMode::Files, finishedScanningAlbum(), Digikam::CoreDB::getAlbumModificationDate(), Digikam::CoreDB::getItemScanInfos(), Digikam::CollectionScanner::Private::ignoreDirectory, Digikam::MetaEngineSettings::instance(), itemsWereRemoved(), Digikam::RedEye::location(), Digikam::DatabaseFields::Name, Digikam::CollectionScanner::Private::nameFilters, Digikam::CoreDB::removeItems(), Digikam::s_modificationDateEquals(), scanFileNormal(), Digikam::CollectionScanner::Private::scannedAlbums, scannedFiles(), scanNewFile(), Digikam::CoreDB::setAlbumDate(), Digikam::CoreDB::setAlbumModificationDate(), Digikam::MetaEngineSettings::settings(), startScanningAlbum(), Digikam::MetaEngineSettingsContainer::useXMPSidecar4Reading, and Digikam::CollectionScanner::Private::wantSignals.

Referenced by finishCompleteScan(), partialScan(), and scanAlbumRoot().

◆ scanAlbumRoot()

void Digikam::CollectionScanner::scanAlbumRoot ( const CollectionLocation &  location)
protected

References Digikam::CollectionScanner::Private::albumDateCache, Digikam::CoreDbAccess::db(), finishedScanningAlbumRoot(), Digikam::CoreDB::getAlbumForPath(), Digikam::CoreDB::getNumberOfItemsInAlbum(), Digikam::MetaEngineSettings::instance(), Digikam::RedEye::location(), Digikam::CollectionScanner::Private::performFastScan, Digikam::s_modificationDateEquals(), scanAlbum(), Digikam::CollectionScanner::Private::scannedAlbums, scannedFiles(), Digikam::MetaEngineSettings::settings(), startScanningAlbumRoot(), Digikam::MetaEngineSettingsContainer::useFastScan, and Digikam::CollectionScanner::Private::wantSignals.

Referenced by completeScan(), finishCompleteScan(), and partialScan().

◆ scanExistingFile()

void Digikam::CollectionScanner::scanExistingFile ( const QFileInfo &  fi,
qlonglong  id 
)
protected

◆ scanFile() [1/4]

void Digikam::CollectionScanner::scanFile ( const ItemInfo &  info,
FileScanMode  mode = ModifiedScan 
)

The given file represented by the ItemInfo will be scanned according to mode

References Digikam::ItemInfo::albumId(), Digikam::ItemInfo::filePath(), Digikam::ItemInfo::id(), Digikam::ItemInfo::isLocationAvailable(), Digikam::ItemInfo::isNull(), and scanFile().

◆ scanFile() [2/4]

qlonglong Digikam::CollectionScanner::scanFile ( const QFileInfo &  fi,
int  albumId,
qlonglong  id,
FileScanMode  mode 
)
protected

References Digikam::CoreDbAccess::db(), finishHistoryScanning(), Digikam::CoreDB::getItemScanInfo(), mainEntryPoint(), ModifiedScan, NormalScan, Rescan, rescanFile(), scanFileNormal(), scanModifiedFile(), scanNewFile(), and scanNewFileFullScan().

◆ scanFile() [3/4]

qlonglong Digikam::CollectionScanner::scanFile ( const QString &  albumRoot,
const QString &  album,
const QString &  fileName,
FileScanMode  mode = ModifiedScan 
)

Same procedure as above, but albumRoot and album is provided. If you already have this info it need not be retrieved. Returns the image id of the file, or -1 on failure.

References checkAlbum(), Digikam::CoreDbAccess::db(), Digikam::CoreDB::getImageId(), Digikam::CollectionManager::instance(), Digikam::RedEye::location(), Digikam::CollectionManager::locationForAlbumRootPath(), and scanFile().

◆ scanFile() [4/4]

qlonglong Digikam::CollectionScanner::scanFile ( const QString &  filePath,
FileScanMode  mode = ModifiedScan 
)

The given file will be scanned according to the given mode. Returns the image id of the file.

References Digikam::CollectionManager::album(), Digikam::CollectionManager::albumRootPath(), and Digikam::CollectionManager::instance().

Referenced by Digikam::MetadataTask::run(), scanFile(), Digikam::ScanController::scannedInfo(), Digikam::DBInfoIface::slotMetadataChangedForUrl(), and Digikam::FileActionMngrFileWorker::transform().

◆ scanFileNormal()

void Digikam::CollectionScanner::scanFileNormal ( const QFileInfo &  info,
const ItemScanInfo &  scanInfo,
bool  checkSidecar = true 
)
protected

References Digikam::ItemScanInfo::fileSize, Digikam::CollectionScannerHintContainerImplementation::hasAnyNormalHint(), Digikam::CollectionScannerHintContainerImplementation::hasMetadataAboutToAdjustHint(), Digikam::CollectionScannerHintContainerImplementation::hasModificationHint(), Digikam::CollectionScannerHintContainerImplementation::hasRescanHint(), Digikam::MetaEngine::hasSidecar(), Digikam::CollectionScanner::Private::hints, Digikam::ItemScanInfo::id, Digikam::MetaEngineSettings::instance(), Digikam::CollectionScannerHintContainerImplementation::lock, Digikam::CollectionScannerHintContainerImplementation::metadataAdjustedHints, Digikam::ItemScanInfo::modificationDate, Digikam::CollectionScannerHintContainerImplementation::modifiedItemHints, rescanFile(), Digikam::MetaEngineSettingsContainer::rescanImageIfModified, Digikam::CollectionScannerHintContainerImplementation::rescanItemHints, Digikam::s_modificationDateEquals(), scanFileUpdateHashReuseThumbnail(), scanModifiedFile(), Digikam::MetaEngineSettings::settings(), Digikam::MetaEngine::sidecarPath(), Digikam::MetaEngineSettingsContainer::updateFileTimeStamp, Digikam::CollectionScanner::Private::updatingHashHint, and Digikam::MetaEngineSettingsContainer::useXMPSidecar4Reading.

Referenced by scanAlbum(), and scanFile().

◆ scanFileUpdateHashReuseThumbnail()

void Digikam::CollectionScanner::scanFileUpdateHashReuseThumbnail ( const QFileInfo &  fi,
const ItemScanInfo &  scanInfo,
bool  fileWasEdited 
)
protected

References category(), Digikam::ThumbsDbAccess::db(), Digikam::ItemScanner::fileModified(), Digikam::ItemScanInfo::fileSize, Digikam::ThumbsDb::findByHash(), Digikam::CollectionScanner::Private::finishScanner(), Digikam::ThumbsDbInfo::id, Digikam::ThumbsDb::insertUniqueHash(), Digikam::ThumbsDbAccess::isInitialized(), Digikam::ItemScanner::itemScanInfo(), Digikam::ItemScanInfo::modificationDate, Digikam::ThumbsDb::replaceUniqueHash(), Digikam::ItemScanner::setCategory(), Digikam::ItemScanInfo::uniqueHash, and Digikam::ThumbsDb::updateModificationDate().

Referenced by scanFileNormal().

◆ scanForStaleAlbums() [1/2]

void Digikam::CollectionScanner::scanForStaleAlbums ( const QList< CollectionLocation > &  locations)
protected

References Digikam::RedEye::location().

Referenced by completeScan(), and partialScan().

◆ scanForStaleAlbums() [2/2]

void Digikam::CollectionScanner::scanForStaleAlbums ( const QList< int > &  locationIdsToScan)
protected

References Digikam::CollectionScanner::Private::albumDateCache, Digikam::CollectionScannerHintContainerImplementation::albumHints, Digikam::CoreDbAccess::db(), finishedScanningForStaleAlbums(), Digikam::CoreDB::getAlbumAndSubalbumsForPath(), Digikam::CoreDB::getAlbumShortInfos(), Digikam::CollectionScanner::Private::hints, Digikam::CollectionScanner::Private::ignoreDirectory, Digikam::CollectionManager::instance(), Digikam::RedEye::location(), Digikam::CollectionManager::locationForAlbumRootId(), Digikam::CollectionScannerHintContainerImplementation::lock, Digikam::CollectionScanner::Private::needTotalFiles, Digikam::CoreDB::renameAlbum(), Digikam::s_modificationDateEquals(), safelyRemoveAlbums(), Digikam::CollectionScanner::Private::scannedAlbums, scannedFiles(), startScanningForStaleAlbums(), totalFilesToScan(), and Digikam::CollectionScanner::Private::wantSignals.

◆ scanModifiedFile()

void Digikam::CollectionScanner::scanModifiedFile ( const QFileInfo &  info,
const ItemScanInfo &  scanInfo 
)
protected

References category(), Digikam::CollectionScanner::Private::checkDeferred(), Digikam::ItemScanner::fileModified(), Digikam::CollectionScanner::Private::finishScanner(), and Digikam::ItemScanner::setCategory().

Referenced by scanFile(), and scanFileNormal().

◆ scannedFiles

void Digikam::CollectionScanner::scannedFiles ( int  filesScanned)
signal

Emitted between startScanningAlbum and finishedScanningAlbum. In between these two signals, the sum of filesScanned of all sent signals equals the one reported by finishedScanningAlbum()

Referenced by scanAlbum(), scanAlbumRoot(), and scanForStaleAlbums().

◆ scanNewFile()

qlonglong Digikam::CollectionScanner::scanNewFile ( const QFileInfo &  info,
int  albumId 
)
protected

References category(), Digikam::CollectionScanner::Private::checkDeferred(), Digikam::ItemScanner::copiedFrom(), Digikam::CoreDbAccess::db(), Digikam::CollectionScanner::Private::establishedSourceAlbums, Digikam::CollectionScanner::Private::finishScanner(), Digikam::CoreDB::getImageId(), Digikam::CollectionScanner::Private::hints, Digikam::ItemScanner::id(), Digikam::CollectionScannerHintContainerImplementation::itemHints, Digikam::CollectionScannerHintContainerImplementation::lock, Digikam::ItemScanner::newFile(), Digikam::CollectionScanner::Private::newIdsList, and Digikam::ItemScanner::setCategory().

Referenced by scanAlbum(), and scanFile().

◆ scanNewFileFullScan()

qlonglong Digikam::CollectionScanner::scanNewFileFullScan ( const QFileInfo &  info,
int  albumId 
)
protected

References category(), Digikam::CollectionScanner::Private::checkDeferred(), Digikam::CollectionScanner::Private::finishScanner(), Digikam::ItemScanner::id(), Digikam::ItemScanner::newFileFullScan(), and Digikam::ItemScanner::setCategory().

Referenced by scanFile().

◆ setDeferredFileScanning()

void Digikam::CollectionScanner::setDeferredFileScanning ( bool  defer)

References Digikam::CollectionScanner::Private::deferredFileScanning.

Referenced by Digikam::ScanController::run().

◆ setHintContainer()

void Digikam::CollectionScanner::setHintContainer ( CollectionScannerHintContainer *const  container)

References Digikam::CollectionScanner::Private::hints.

Referenced by Digikam::ScanController::run(), and Digikam::ScanController::scannedInfo().

◆ setNeedFileCount()

void Digikam::CollectionScanner::setNeedFileCount ( bool  on)

Call this to enable emitting the total files to scan (for progress info) before a complete collection scan. Default is off. If on, setSignalEnabled() must be on to take effect.

References Digikam::CollectionScanner::Private::needTotalFiles.

Referenced by Digikam::ScanController::run(), and Digikam::CoreDbSchemaUpdater::updateUniqueHash().

◆ setObserver()

void Digikam::CollectionScanner::setObserver ( CollectionScannerObserver *const  observer)

Set an observer to be able to cancel a running scan

References Digikam::CollectionScanner::Private::observer.

Referenced by Digikam::ScanController::run(), and Digikam::CoreDbSchemaUpdater::updateUniqueHash().

◆ setPerformFastScan()

void Digikam::CollectionScanner::setPerformFastScan ( bool  on)

Call this to disable fast scan with album date check. Default is on.

References Digikam::CollectionScanner::Private::performFastScan.

Referenced by Digikam::ScanController::run().

◆ setSignalsEnabled()

void Digikam::CollectionScanner::setSignalsEnabled ( bool  on)

Call this to enable the progress info signals. Default is off.

References Digikam::CollectionScanner::Private::wantSignals.

◆ setUpdateHashHint()

void Digikam::CollectionScanner::setUpdateHashHint ( bool  hint = true)

References Digikam::CollectionScanner::Private::updatingHashHint.

Referenced by Digikam::CoreDbSchemaUpdater::updateUniqueHash().

◆ signalScannedNewImage

void Digikam::CollectionScanner::signalScannedNewImage ( const QFileInfo &  info)
signal

◆ startCompleteScan

void Digikam::CollectionScanner::startCompleteScan ( )
signal

Referenced by completeScan(), and finishCompleteScan().

◆ startScanningAlbum

void Digikam::CollectionScanner::startScanningAlbum ( const QString &  albumRoot,
const QString &  album 
)
signal

Referenced by scanAlbum().

◆ startScanningAlbumRoot

void Digikam::CollectionScanner::startScanningAlbumRoot ( const QString &  albumRoot)
signal

Notifies the begin of the scanning of the specified album root, album, of stale files, or of the whole collection (after stale files)

Referenced by scanAlbumRoot().

◆ startScanningAlbumRoots

void Digikam::CollectionScanner::startScanningAlbumRoots ( )
signal

Referenced by completeScan(), and finishCompleteScan().

◆ startScanningForStaleAlbums

void Digikam::CollectionScanner::startScanningForStaleAlbums ( )
signal

Referenced by scanForStaleAlbums().

◆ totalFilesToScan

void Digikam::CollectionScanner::totalFilesToScan ( int  count)
signal

Emitted once in scanAlbums(), the scan() methods, and updateItemsWithoutDate(). Gives the number of the files that need to be scanned.

Referenced by completeScan(), finishCompleteScan(), and scanForStaleAlbums().

◆ updateRemovedItemsTime()

void Digikam::CollectionScanner::updateRemovedItemsTime ( )
protected

References Digikam::CoreDbAccess::db(), Digikam::CollectionScanner::Private::removedItemsTime, and Digikam::CoreDB::setSetting().

Referenced by completeScanCleanupPart(), and partialScan().

The documentation for this class was generated from the following files: