MIN_DESCRIPTION_LENGTH
MIN_DESCRIPTION_LENGTH
the minimum length of a description before we stop appending additional link doc summaries
Used to manage data related to video, news, and other search sources Also, used to manage data about available subsearches seen in SearchView
__construct(string $db_name = \seekquarry\yioop\configs\DB_NAME, boolean $connect = true, $web_site = null)
Sets up the database manager that will be used and name of the search engine database
| string | $db_name | the name of the database for the search engine |
| boolean | $connect | whether to connect to the database by default after making the datasource class |
| $web_site |
getCrawlItem(string $url, array $machine_urls = null, string $index_name = "") : array
Get a summary of a document by the generation it is in and its offset into the corresponding WebArchive.
| string | $url | of summary we are trying to look-up |
| array | $machine_urls | an array of urls of yioop queue servers |
| string | $index_name | timestamp of the index to do the lookup in |
summary data of the matching document
getCrawlItems(string $lookups, array $machine_urls = null, array $exclude_fields = array(), array $format_words = null, integer $description_length = self::DEFAULT_DESCRIPTION_LENGTH) : array
Gets summaries for a set of document by their url, or by group of 5-tuples of the form (machine, key, index, generation, offset).
| string | $lookups | things whose summaries we are trying to look up |
| array | $machine_urls | an array of urls of yioop queue servers |
| array | $exclude_fields | an array of fields which might be int the crawlItem but which should be excluded from the result. This will make the result smaller and so hopefully faster to transmit |
| array | $format_words | words which should be highlighted in search snippets returned |
| integer | $description_length | length of snippets to be returned for each search result |
of summary data for the matching documents
networkGetCrawlItems(string $lookups, array $machine_urls, array $exclude_fields = array(), array $format_words = null, integer $description_length = self::DEFAULT_DESCRIPTION_LENGTH) : array
In a multiple queue server setting, gets summaries for a set of document by their url, or by group of 5-tuples of the form (machine, key, index, generation, offset). This makes an execMachines call to make a network request to the CrawlController's on each machine which in turn calls getCrawlItems (and thence nonNetworkGetCrawlItems) on each machine. The results are then sent back to networkGetCrawlItems and aggregated.
| string | $lookups | things whose summaries we are trying to look up |
| array | $machine_urls | an array of urls of yioop queue servers |
| array | $exclude_fields | an array of fields which might be int the crawlItem but which should be excluded from the result. This will make the result smaller and so hopefully faster to transmit |
| array | $format_words | words which should be highlighted in search snippets returned |
| integer | $description_length | length of snippets to be returned for each search result |
of summary data for the matching documents
nonNetworkGetCrawlItems(string $lookups, array $exclude_fields = array(), array $format_words = null, integer $description_length = self::DEFAULT_DESCRIPTION_LENGTH) : array
Gets summaries on a particular machine for a set of document by their url, or by group of 5-tuples of the form (machine, key, index, generation, offset) This may be used in either the single queue_server setting or it may be called indirectly by a particular machine's CrawlController as part of fufilling a network-based getCrawlItems request. $lookups contains items which are to be grouped (as came from same url or site with the same cache). So this function aggregates their descriptions.
| string | $lookups | things whose summaries we are trying to look up |
| array | $exclude_fields | an array of fields which might be int the crawlItem but which should be excluded from the result. This will make the result smaller and so hopefully faster to transmit |
| array | $format_words | words which should be highlighted in search snippets returned |
| integer | $description_length | length of snippets to be returned for each search result |
of summary data for the matching documents
lookupSummaryOffsetGeneration(string $url_or_key, string $index_name = "", boolean $is_key = false) : array
Determines the offset into the summaries WebArchiveBundle and generation of the provided url (or hash_url) so that the info:url (info:base64_hash_url) summary can be retrieved. This assumes of course that the info:url meta word has been stored.
| string | $url_or_key | either info:base64_hash_url or just a url to lookup |
| string | $index_name | index into which to do the lookup |
| boolean | $is_key | whether the string is info:base64_hash_url or just a url |
(offset, generation) into the web archive bundle
clearQuerySavePoint(integer $save_timestamp, array $machine_urls = null)
A save point is used to store to disk a sequence generation-doc-offset pairs of a particular mix query when doing an archive crawl of a crawl mix. This is used so that the mix can remember where it was the next time it is invoked by the web app on the machine in question.
This function deletes such a save point associated with a timestamp
| integer | $save_timestamp | timestamp of save point to delete |
| array | $machine_urls | machines on which to try to delete savepoint |
execMachines(string $command, array $machine_urls, string $arg = null, integer $num_machines, boolean $send_specs = false) : array
This method is invoked by other ParallelModel (@see CrawlModel for examples) methods when they want to have their method performed on an array of other Yioop instances. The results returned can then be aggregated. The invocation sequence is crawlModelMethodA invokes execMachine with a list of urls of other Yioop instances. execMachine makes REST requests of those instances of the given command and optional arguments This request would be handled by a CrawlController which in turn calls crawlModelMethodA on the given Yioop instance, serializes the result and gives it back to execMachine and then back to the originally calling function.
| string | $command | the ParallelModel method to invoke on the remote Yioop instances |
| array | $machine_urls | machines to invoke this command on |
| string | $arg | additional arguments to be passed to the remote machine |
| integer | $num_machines | the integer to be used in calculating partition |
| boolean | $send_specs | whether to send the queue_server, num fetcher info for given machine |
a list of outputs from each machine that was called.
fileGetContents(string $filename, boolean $force_read = false) : string
Either a wrapper for file_get_contents, or if a WebSite object is being used to serve pages, it reads it in using blocking I/O file_get_contents() and caches it before return its string contents.
Note this function assumes that only the web server is performing I/O with this file. filemtime() can be used to see if a file on disk has been changed and then you can use $force_read = true below to force re- reading the file into the cache
| string | $filename | name of file to get contents of |
| boolean | $force_read | whether to force the file to be read from presistent storage rather than the cache |
contents of the file given by $filename
filePutContents(string $filename, string $data)
Either a wrapper for file_put_contents, or if a WebSite object is being used to serve pages, writes $data to the persistent file with name $filename. Saves a copy in the RAM cache if there is a copy already there.
| string | $filename | name of file to write to persistent storages |
| string | $data | string of data to store in file |
formatSinglePageResult(array $page, array $words = null, integer $description_length = self::DEFAULT_DESCRIPTION_LENGTH) : array
Given a page summary, extracts snippets which are related to a set of search words. For each snippet, bold faces the search terms, and then creates a new summary array.
| array | $page | a single search result summary |
| array | $words | keywords (typically what was searched on) |
| integer | $description_length | length of the description |
$page which has been snippified and bold faced
getSnippets(string $text, array $words, string $description_length) : string
Given a string, extracts a snippets of text related to a given set of key words. For a given word a snippet is a window of characters to its left and right that is less than a maximum total number of characters.
There is also a rule that a snippet should avoid ending in the middle of a word
| string | $text | haystack to extract snippet from |
| array | $words | keywords used to make look in haystack |
| string | $description_length | length of the description desired |
a concatenation of the extracted snippets of each word
boldKeywords(string $text, array $words) : string
Given a string, wraps in bold html tags a set of key words it contains.
| string | $text | haystack string to look for the key words |
| array | $words | an array of words to bold face |
the resulting string after boldfacing has been applied
isSingleLocalhost(array $machine_urls, string $index_timestamp = -1) : boolean
Used to determine if an action involves just one yioop instance on the current local machine or not
| array | $machine_urls | urls of yioop instances to which the action applies |
| string | $index_timestamp | if timestamp exists checks if the index has declared itself to be a no network index. |
whether it involves a single local yioop instance (true) or not (false)
searchArrayToWhereOrderClauses(array $search_array, array $any_fields = array('status')) : array
Creates the WHERE and ORDER BY clauses for a query of a Yioop table such as USERS, ROLE, GROUP, which have associated search web forms. Searches are case insensitive
| array | $search_array | each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by |
| array | $any_fields | these fields if present in search array but with value "-1" will be skipped as part of the where clause but will be used for order by clause |
string for where clause, string for order by clause
getRows(integer $limit, integer $num, \seekquarry\yioop\models\int& $total, array $search_array = array(), array $args = null) : array
Gets a range of rows which match the provided search criteria from $th provided table
| integer | $limit | starting row from the potential results to return |
| integer | $num | number of rows after start row to return |
| \seekquarry\yioop\models\int& | $total | gets set with the total number of rows that can be returned by the given database query |
| array | $search_array | each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by |
| array | $args | additional values which may be used to get rows (what these are will typically depend on the subclass implementation) |
selectCallback(mixed $args = null) : string
Controls which columns and the names of those columns from the tables underlying the given model should be return from a getRows call.
This defaults to *, but in general will be overriden in subclasses of Model
| mixed | $args | any additional arguments which should be used to determine the columns |
a comma separated list of columns suitable for a SQL query
fromCallback(string $args = null) : string
Controls which tables and the names of tables underlie the given model and should be used in a getRows call As SourceModel is used for both media sources and subsearches.
The underlying table might be MEDIA_SOURCE or it might be SUBSEARCH. The $args variable is a string which is assumed to say which.
| string | $args | if is "SUBSEARCH" then the SUBSEARCH table will be used by getRows rather than MEDIA_SOURCE. |
which table to use
whereCallback(mixed $args = null) : string
Controls the WHERE clause of the SQL query that underlies the given model and should be used in a getRows call.
This defaults to an empty WHERE clause.
| mixed | $args | additional arguments that might be used to construct the WHERE clause. |
a SQL WHERE clause
rowCallback(array $row, mixed $args) : array
Called after as row is retrieved by getRows from the database to perform some manipulation that would be useful for this model.
For example, in CrawlModel, after a row representing a crawl mix has been gotten, this is used to perform an additional query to marshal its components. By default this method just returns this row unchanged.
| array | $row | row as retrieved from database query |
| mixed | $args | additional arguments that might be used by this callback |
$row after callback manipulation
postQueryCallback(array $rows) : array
Called after getRows has retrieved all the rows that it would retrieve but before they are returned to give one last place where they could be further manipulated. For example, in MachineModel this callback is used to make parallel network calls to get the status of each machine returned by getRows. The default for this method is to leave the rows that would be returned unchanged
| array | $rows | that have been calculated so far by getRows |
$rows after this final manipulation
getMediaSources(string $source_type = "") : array
Returns a list of media sources such as (video, rss sites) and their URL and thumb url formats, etc
| string | $source_type | the particular kind of media source to return for example, video |
a list of web sites which are either video or news sites
getMediaCategories(array $exclude_categories = array(), string $type = "") : array
Returns the media categories of the search sources that have been stored
| array | $exclude_categories | |
| string | $type |
of arrays distinct ["NAME" => media category, "TYPE" => source_type]
addMediaSource(string $name, string $source_type, string $source_category, string $source_url, string $aux_info, string $language = \seekquarry\yioop\configs\DEFAULT_LOCALE)
Used to add a new video, rss, html news, or other sources to Yioop
| string | $name | user-friendly name for media source, for example, New York Times |
| string | $source_type | whether rss, html, json, regex, feed podcast scrape podcast |
| string | $source_category | whether news, weather, etc. |
| string | $source_url | url regex of resource (video) or actual resource (rss). Not quite a real regex you add {} to the location in the url where the name of the particular video should go http://www.youtube.com/watch?v={}& (anything after & is ignored, so between = and & will be matched as the name of a video) |
| string | $aux_info | xpaths or regex to scrape news items or podcast feeds |
| string | $language | the locale tag for the media source (rss) |
getSubsearchName(string $folder_name, string $locale_tag) : string
Given the folder name for a subsearch and a locale tag return the natural language name in that for the subsearch
| string | $folder_name | of subsearch want to look up |
| string | $locale_tag | of language want human understandable subsearch name |
natural language name of subsearch
addSubsearch(string $folder_name, string $index_identifier, integer $per_page, string $default_query = "")
Adds a new subsearch to the list of subsearches. This are displayed at the top od the Yioop search pages.
| string | $folder_name | name of subsearch in terms of urls (not translated name that appears in the subsearch bar) |
| string | $index_identifier | timestamp of crawl or mix to be used for results of subsearch |
| integer | $per_page | number of search results per page when this subsearch is used |
| string | $default_query | query to use when using subsearch if no query provided by user. For example, for image search this might be the empty query, for news it might be lang:default to get all the news for the default locale. |
clearFeedData(array $machine_urls = null)
Used to delete any feed data (IndexDataFeed bundle) and trending data in this Yioop installation.
| array | $machine_urls | a list of machines which are running MediaUpdaters for this instance of Yioop. If empty assume is just the Name Server |