UmbracoExamine

An abstract provider containing the basic functionality to be able to query against Umbraco data.

Default constructor

Constructor to allow for creating an indexer at runtime

Creates an NRT indexer

Used for unit tests

If true, the IndexingActionHandler will be run to keep the default index up to date.

Determines if the manager will call the indexing methods when content is saved or deleted as opposed to cache being updated.

The data service used for retreiving and submitting data to the cms

the supported indexable types

Setup the properties for the indexer from the provider settings

Used to aquire the internal searcher

override to check if we can actually initialize.

This check is required since the base examine lib will try to rebuild on startup

override to check if we can actually initialize.

This check is required since the base examine lib will try to rebuild on startup

override to check if we can actually initialize.

This check is required since the base examine lib will try to rebuild on startup

Returns true if the Umbraco application is in a state that we can initialize the examine indexes

Ensures that the node being indexed is of a correct type and is a descendent of the parent id specified.

Reindexes all supported types

Builds an xpath statement to query against Umbraco data for the index type specified, then initiates the re-indexing of the data matched.

Extension methods for IndexSet

Convert the indexset to indexerdata. This detects if there are no user/system fields specified and if not, uses the data service to look them up and update the in memory IndexSet.

Returns a list of ALL properties names for all nodes defined in the data source

Returns a list of ALL system property names for all nodes defined in the data source

A Dto object for returning property aliases from PetaPoco

removes html markup from a string

Gets published content by xpath

This is quite an intensive operation... get all root content, then get the XML structure for all children, then run xpath against the navigator that's created

Check if the node is protected

Returns a list of all of the user defined property names in Umbraco

Returns a list of all system field names in Umbraco

Data service used to query for media

This is quite an intensive operation... get all root media, then get the XML structure for all children, then run xpath against the navigator that's created

The index types stored in the Lucene Index

The content index type

Is lower case because the Standard Analyzer requires lower case

The media index type

Is lower case because the Standard Analyzer requires lower case

The member index type

Is lower case because the Standard Analyzer requires lower case

This is only used for backward compatibility to get access to the umbraco.library object but this needs to be done via reflection because of the circular reference we have between Umbraco.Web and UmbracoExamine.

When running on Azure websites, we can use the local user's storage space

Use the ASP.Net CodeGen folder to store the index files

This is the default implementation - but it comes with it's own limitations - the CodeGen folder is cleared whenever new DLLs are changed in the /bin folder (among other circumstances) which means the index would be re-synced (or rebuilt) there.

Used to resolve the local storage folder

Used to read data from local temp storage and write to both local storage and main storage

If initialization fails, it will be disabled and then this will just wrap the 'real directory'

Returns true if a file with the given name exists.

Returns the time the named file was last modified.

Set the modified time of an existing file to now.

Removes an existing file in the directory.

Returns the length of a file in the directory.

Creates a new, empty file in the directory with the given name. Returns a stream writing this file.

Returns a stream reading an existing file.

Creates an IndexInput for the file with the given name.

Ensure that any writes to this file are moved to stable storage. Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index.

Return a string identifier that uniquely differentiates this Directory instance from other Directory instances. This ID should be the same if two Directory instances (even in different JVMs and/or on different machines) are considered "the same index". This is how locking "scopes" to the right index.

Attempts to create an index writer, it will retry on failure 5 times and on the last time will try to forcefully unlock the index files

Lock that wraps multiple locks

Attempts to obtain exclusive access and immediately return upon success or failure.

true iff exclusive access is obtained

Releases exclusive access.

Returns true if the resource is currently locked. Note that one must still call before using the resource.

Lock factory that wraps multiple factories

Implements TryGetValue using the underlying dictionary

Custom indexer for members

Default constructor

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Ensures that the'_searchEmail' is added to the user fields so that it is indexed - without having to modify the config

The supported types for this indexer

Reindex all members

Add the special __key and _searchEmail fields

Static methods to help query umbraco xml

Converts a content node to XDocument

true if data is going to be returned from cache If the type of node is not a Document, the cacheOnly has no effect, it will use the API to return the xml.

Converts a content node to Xml

Default constructor

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Creates an NRT indexer

Used to store the path of a content object

The prefix added to a field when it is duplicated in order to store the original raw value.

A type that defines the type of index for each Umbraco field (non user defined fields) Alot of standard umbraco fields shouldn't be tokenized or even indexed, just stored into lucene for retreival after searching.

Set up all properties for the indexer based on configuration information specified. This will ensure that all of the folders required by the indexer are created and exist. This will also create an instruction file declaring the computer name that is part taking in the indexing. This file will then be used to determine the master indexer machine in a load balanced environment (if one exists).

The friendly name of the provider. A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider. The name of the provider is null. The name of the provider has a length of zero. An attempt is made to call on a provider after the provider has already been initialized.

Whether to use the cmsContentXml data to re-index when possible (i.e. for published content, media and members)

By default this is false, if set to true then the indexer will include indexing content that is flagged as publicly protected. This property is ignored if SupportUnpublishedContent is set to true.

This ensures that the special __Raw_ fields are indexed

Overridden for logging

Deletes a node from the index.

When a content node is deleted, we also need to delete it's children from the index so we need to perform a custom Lucene search to find all decendents and create Delete item queues for them too. ID of the node to delete

Performs a reindex of a type based on looking up entries from the cmsContentXml table - but using callbacks to get this data since we don't have a common underlying service interface for the media/content stuff

Overridden for logging.

Used to refresh the current IndexerData from the data in the DataService. This can be used if there are more properties added/removed from the database

Override this method to strip all html from all user fields before raising the event, then after the event ensure our special Path field is added to the collection

Called when a duplicate field is detected in the dictionary that is getting indexed.

Overridden to add the path property to the special fields to index

Creates an IIndexCriteria object based on the indexSet passed in and our DataService

If we cannot initialize we will pass back empty indexer data since we cannot read from the database

return the index policy for the field name passed in, if not found, return normal

Ensure that the content of this node is available for indexing (i.e. don't allow protected content to be indexed when this is disabled).

An Examine searcher which uses Lucene.Net as the

Default constructor

we override name because we need to manually set it if !CanInitialize() since we cannot call base.Initialize in that case.

Constructor to allow for creating an indexer at runtime

Constructor to allow for creating an indexer at runtime

Creates an NRT searcher

Used for unit tests

Returns true if the Umbraco application is in a state that we can initialize the examine indexes

Override in order to set the nodeTypeAlias field name of the underlying SearchCriteria to __NodeTypeAlias

Returns a list of fields to search on, this will also exclude the IndexPathFieldName and node type alias

Methods to support Umbraco XSLT extensions.

XSLT extensions will ONLY work for provider that have a base class of BaseUmbracoIndexer

Uses the provider specified to search, returning an XPathNodeIterator

Uses the provider specified to search, returning an XPathNodeIterator

The search text. if set to true [use wildcards]. Name of the provider. Type of the index.

Uses the provider specified to search, returning an XPathNodeIterator

Uses the default provider specified to search, returning an XPathNodeIterator

The search query Enable a wildcard search query A node-set of the search results

Uses the default provider specified to search, returning an XPathNodeIterator

The search query A node-set of the search results

Will perform a search against the media index type only

Will perform a search against the media index type only

Will perform a search against the media index type only

Searches the member only.

The search text. if set to true [use wildcards]. Name of the provider.

Searches the member only.

The search text. if set to true [use wildcards].

Searches the member only.

The search text.

Will perform a search against the content index type only

Will perform a search against the content index type only

Will perform a search against the content index type only

Gets the results as XML.

The results.