TrackerMinerFS

TrackerMinerFS — Abstract base class for filesystem miners

Synopsis

#include <libtracker-miner/tracker-miner.h>

                    TrackerMinerFSPrivate;
struct              TrackerMinerFS;
                    TrackerMinerFSClass;
void                tracker_miner_fs_check_directory    (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean check_parents);
void                tracker_miner_fs_check_file         (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean check_parents);
void                tracker_miner_fs_directory_add      (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean recurse);
gboolean            tracker_miner_fs_directory_remove   (TrackerMinerFS *fs,
                                                         GFile *file);
gboolean            tracker_miner_fs_directory_remove_full
                                                        (TrackerMinerFS *fs,
                                                         GFile *file);
void                tracker_miner_fs_file_notify        (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         const GError *error);
void                tracker_miner_fs_set_throttle       (TrackerMinerFS *fs,
                                                         gdouble throttle);
gdouble             tracker_miner_fs_get_throttle       (TrackerMinerFS *fs);
void                tracker_miner_fs_force_recheck      (TrackerMinerFS *fs);
const gchar *       tracker_miner_fs_get_parent_urn     (TrackerMinerFS *fs,
                                                         GFile *file);
const gchar *       tracker_miner_fs_get_urn            (TrackerMinerFS *fs,
                                                         GFile *file);
gchar *             tracker_miner_fs_query_urn          (TrackerMinerFS *fs,
                                                         GFile *file);
void                tracker_miner_fs_add_directory_without_parent
                                                        (TrackerMinerFS *fs,
                                                         GFile *file);
gboolean            tracker_miner_fs_get_initial_crawling
                                                        (TrackerMinerFS *fs);
void                tracker_miner_fs_set_initial_crawling
                                                        (TrackerMinerFS *fs,
                                                         gboolean do_initial_crawling);
gboolean            tracker_miner_fs_get_mtime_checking (TrackerMinerFS *fs);
void                tracker_miner_fs_set_mtime_checking (TrackerMinerFS *fs,
                                                         gboolean mtime_checking);
void                tracker_miner_fs_force_mtime_checking
                                                        (TrackerMinerFS *fs,
                                                         GFile *directory);
gboolean            tracker_miner_fs_has_items_to_process
                                                        (TrackerMinerFS *fs);

Description

TrackerMinerFS is an abstract base class for miners that collect data from the filesystem, all the filesystem crawling and monitoring is abstracted away, leaving to implementations the decisions of what directories/files should it process, and the actual data extraction.

Details

TrackerMinerFSPrivate

typedef struct _TrackerMinerFSPrivate TrackerMinerFSPrivate;


struct TrackerMinerFS

struct TrackerMinerFS {
	TrackerMiner parent;
	TrackerMinerFSPrivate *priv;
};

Abstract miner implementation to get data from the filesystem.


TrackerMinerFSClass

typedef struct {
	TrackerMinerClass parent;

	gboolean (* check_file)               (TrackerMinerFS       *fs,
	                                       GFile                *file);
	gboolean (* check_directory)          (TrackerMinerFS       *fs,
	                                       GFile                *file);
	gboolean (* check_directory_contents) (TrackerMinerFS       *fs,
	                                       GFile                *parent,
	                                       GList                *children);
	gboolean (* process_file)             (TrackerMinerFS       *fs,
	                                       GFile                *file,
	                                       TrackerSparqlBuilder *builder,
	                                       GCancellable         *cancellable);
	gboolean (* ignore_next_update_file)  (TrackerMinerFS       *fs,
	                                       GFile                *file,
	                                       TrackerSparqlBuilder *builder,
	                                       GCancellable         *cancellable);
	gboolean (* monitor_directory)        (TrackerMinerFS       *fs,
	                                       GFile                *file);
	void     (* finished)                 (TrackerMinerFS       *fs);
	gboolean (* process_file_attributes)  (TrackerMinerFS       *fs,
	                                       GFile                *file,
	                                       TrackerSparqlBuilder *builder,
	                                       GCancellable         *cancellable);
	gboolean (* writeback_file)           (TrackerMinerFS       *fs,
	                                       GFile                *file,
	                                       GStrv                 rdf_types,
	                                       GPtrArray            *results);
} TrackerMinerFSClass;

Prototype for the abstract class, check_file, check_directory, check_directory_contents, process_file and monitor_directory must be implemented in the deriving class in order to actually extract data.

TrackerMinerClass parent;

parent object class

check_file ()

Called when a file should be checked for further processing.

check_directory ()

Called when a directory should be checked for further processing.

check_directory_contents ()

Called when a directory should be checked for further processing, based on the directory contents.

process_file ()

Called when the metadata associated to a file is requested.

ignore_next_update_file ()

Called after a writeback event happens on a file (deprecated since 0.12).

monitor_directory ()

Called to check whether a directory should be modified.

finished ()

Called when all processing has been performed.

process_file_attributes ()

Called when the metadata associated with a file's attributes changes, for example, the mtime.

writeback_file ()

Called when a file must be written back

tracker_miner_fs_check_directory ()

void                tracker_miner_fs_check_directory    (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean check_parents);

Tells the filesystem miner to check and index a directory, this file must be part of the usual crawling directories of TrackerMinerFS. See tracker_miner_fs_directory_add().

fs :

a TrackerMinerFS

file :

GFile for the directory to check

check_parents :

whether to check parents and eligibility or not

Since 0.10


tracker_miner_fs_check_file ()

void                tracker_miner_fs_check_file         (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean check_parents);

Tells the filesystem miner to check and index a file, this file must be part of the usual crawling directories of TrackerMinerFS. See tracker_miner_fs_directory_add().

fs :

a TrackerMinerFS

file :

GFile for the file to check

check_parents :

whether to check parents and eligibility or not

Since 0.10


tracker_miner_fs_directory_add ()

void                tracker_miner_fs_directory_add      (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean recurse);

Tells the filesystem miner to inspect a directory.

fs :

a TrackerMinerFS

file :

GFile for the directory to inspect

recurse :

whether the directory should be inspected recursively

Since 0.8


tracker_miner_fs_directory_remove ()

gboolean            tracker_miner_fs_directory_remove   (TrackerMinerFS *fs,
                                                         GFile *file);

Removes a directory from being inspected by fs. Note that only directory watches are removed.

fs :

a TrackerMinerFS

file :

GFile for the directory to be removed

Returns :

TRUE if the directory was successfully removed.

Since 0.8


tracker_miner_fs_directory_remove_full ()

gboolean            tracker_miner_fs_directory_remove_full
                                                        (TrackerMinerFS *fs,
                                                         GFile *file);

Removes a directory from being inspected by fs, and removes all associated metadata of the directory (and its contents) from the store.

fs :

a TrackerMinerFS

file :

GFile for the directory to be removed

Returns :

TRUE if the directory was successfully removed.

Since 0.10


tracker_miner_fs_file_notify ()

void                tracker_miner_fs_file_notify        (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         const GError *error);

Notifies fs that all processing on file has been finished, if any error happened during file data processing, it should be passed in error, else that parameter will contain NULL to reflect success.

fs :

a TrackerMinerFS

file :

a GFile

error :

a GError with the error that happened during processing, or NULL.

Since 0.8


tracker_miner_fs_set_throttle ()

void                tracker_miner_fs_set_throttle       (TrackerMinerFS *fs,
                                                         gdouble throttle);

Tells the filesystem miner to throttle its operations. a value of 0 means no throttling at all, so the miner will perform operations at full speed, 1 is the slowest value.

fs :

a TrackerMinerFS

throttle :

throttle value, between 0 and 1

Since 0.8


tracker_miner_fs_get_throttle ()

gdouble             tracker_miner_fs_get_throttle       (TrackerMinerFS *fs);

Gets the current throttle value. see tracker_miner_fs_set_throttle().

fs :

a TrackerMinerFS

Returns :

current throttle value.

Since 0.8


tracker_miner_fs_force_recheck ()

void                tracker_miner_fs_force_recheck      (TrackerMinerFS *fs);


tracker_miner_fs_get_parent_urn ()

const gchar *       tracker_miner_fs_get_parent_urn     (TrackerMinerFS *fs,
                                                         GFile *file);

If file is currently being processed by fs, this function will return the parent folder URN if any. This function is useful to set the nie:belongsToContainer relationship. The processing order of TrackerMinerFS guarantees that a folder has been already fully processed for indexing before any children is processed, so most usually this function should return non-NULL.

fs :

a TrackerMinerFS

file :

a GFile obtained in "process-file"

Returns :

The parent folder URN, or NULL. [transfer none]

Since 0.8


tracker_miner_fs_get_urn ()

const gchar *       tracker_miner_fs_get_urn            (TrackerMinerFS *fs,
                                                         GFile *file);

If the item exists in the store, this function retrieves the URN for a GFile being currently processed.

If file is not being currently processed by fs, or doesn't exist in the store yet, NULL will be returned.

fs :

a TrackerMinerFS

file :

a GFile obtained in "process-file"

Returns :

The URN containing the data associated to file, or NULL. [transfer none]

Since 0.8


tracker_miner_fs_query_urn ()

gchar *             tracker_miner_fs_query_urn          (TrackerMinerFS *fs,
                                                         GFile *file);

If the item exists in the store, this function retrieves the URN of the given GFile

If file doesn't exist in the store yet, NULL will be returned.

fs :

a TrackerMinerFS

file :

a GFile

Returns :

A newly allocated string with the URN containing the data associated to file, or NULL. [transfer full]

Since 0.10


tracker_miner_fs_add_directory_without_parent ()

void                tracker_miner_fs_add_directory_without_parent
                                                        (TrackerMinerFS *fs,
                                                         GFile *file);

Tells the miner-fs that the given GFile corresponds to a directory which was created in the store without a specific parent object. In this case, when regenerating internal caches, an extra query will be done so that these elements are taken into account.

fs :

a TrackerMinerFS

file :

a GFile

Since 0.10


tracker_miner_fs_get_initial_crawling ()

gboolean            tracker_miner_fs_get_initial_crawling
                                                        (TrackerMinerFS *fs);


tracker_miner_fs_set_initial_crawling ()

void                tracker_miner_fs_set_initial_crawling
                                                        (TrackerMinerFS *fs,
                                                         gboolean do_initial_crawling);


tracker_miner_fs_get_mtime_checking ()

gboolean            tracker_miner_fs_get_mtime_checking (TrackerMinerFS *fs);

fs :

a TrackerMinerFS

Returns :

TRUE if mtime checks for directories against the database are done when fs crawls the file system, otherwise FALSE.

Since 0.10


tracker_miner_fs_set_mtime_checking ()

void                tracker_miner_fs_set_mtime_checking (TrackerMinerFS *fs,
                                                         gboolean mtime_checking);

Tells the miner-fs that during the crawling phase, directory mtime checks should or shouldn't be performed against the database to make sure we have the most up to date version of the file being checked at the time. Setting this to FALSE can dramatically improve the start up the crawling of the fs.

The down side is that using this consistently means that some files on the disk may be out of date with files in the database.

The main purpose of this function is for systems where a fs is running the entire time and where it is very unlikely that a file could be changed outside between startup and shutdown of the process using this API.

The default if not set directly is that mtime_checking is TRUE.

fs :

a TrackerMinerFS

mtime_checking :

a gboolean

Since 0.10


tracker_miner_fs_force_mtime_checking ()

void                tracker_miner_fs_force_mtime_checking
                                                        (TrackerMinerFS *fs,
                                                         GFile *directory);

Tells fs to force mtime checking (regardless of the global mtime check configuration) on the given directory.

fs :

a TrackerMinerFS

Since 0.12


tracker_miner_fs_has_items_to_process ()

gboolean            tracker_miner_fs_has_items_to_process
                                                        (TrackerMinerFS *fs);

fs :

a TrackerMinerFS

Returns :

TRUE if there are items to process in the internal queues, otherwise FALSE.

Since 0.10