123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367 |
- <?php
- /**
- * Elgg core search.
- *
- * @package Elgg
- * @subpackage Search
- */
- /**
- * Get objects that match the search parameters.
- *
- * @param string $hook Hook name
- * @param string $type Hook type
- * @param array $value Empty array
- * @param array $params Search parameters
- * @return array
- */
- function search_objects_hook($hook, $type, $value, $params) {
- $db_prefix = elgg_get_config('dbprefix');
- $join = "JOIN {$db_prefix}objects_entity oe ON e.guid = oe.guid";
- $params['joins'] = array($join);
- $fields = array('title', 'description');
- $where = search_get_where_sql('oe', $fields, $params);
- $params['wheres'] = array($where);
- $params['count'] = TRUE;
- $count = elgg_get_entities($params);
-
- // no need to continue if nothing here.
- if (!$count) {
- return array('entities' => array(), 'count' => $count);
- }
-
- $params['count'] = FALSE;
- $params['order_by'] = search_get_order_by_sql('e', 'oe', $params['sort'], $params['order']);
- $params['preload_owners'] = true;
- $entities = elgg_get_entities($params);
- // add the volatile data for why these entities have been returned.
- foreach ($entities as $entity) {
- $title = search_get_highlighted_relevant_substrings($entity->title, $params['query']);
- $entity->setVolatileData('search_matched_title', $title);
- $desc = search_get_highlighted_relevant_substrings($entity->description, $params['query']);
- $entity->setVolatileData('search_matched_description', $desc);
- }
- return array(
- 'entities' => $entities,
- 'count' => $count,
- );
- }
- /**
- * Get groups that match the search parameters.
- *
- * @param string $hook Hook name
- * @param string $type Hook type
- * @param array $value Empty array
- * @param array $params Search parameters
- * @return array
- */
- function search_groups_hook($hook, $type, $value, $params) {
- $db_prefix = elgg_get_config('dbprefix');
- $query = sanitise_string($params['query']);
- $join = "JOIN {$db_prefix}groups_entity ge ON e.guid = ge.guid";
- $params['joins'] = array($join);
-
- $fields = array('name', 'description');
- $where = search_get_where_sql('ge', $fields, $params);
- $params['wheres'] = array($where);
- // override subtype -- All groups should be returned regardless of subtype.
- $params['subtype'] = ELGG_ENTITIES_ANY_VALUE;
- $params['count'] = TRUE;
- $count = elgg_get_entities($params);
-
- // no need to continue if nothing here.
- if (!$count) {
- return array('entities' => array(), 'count' => $count);
- }
-
- $params['count'] = FALSE;
- $params['order_by'] = search_get_order_by_sql('e', 'ge', $params['sort'], $params['order']);
- $entities = elgg_get_entities($params);
- // add the volatile data for why these entities have been returned.
- foreach ($entities as $entity) {
- $name = search_get_highlighted_relevant_substrings($entity->name, $query);
- $entity->setVolatileData('search_matched_title', $name);
- $description = search_get_highlighted_relevant_substrings($entity->description, $query);
- $entity->setVolatileData('search_matched_description', $description);
- }
- return array(
- 'entities' => $entities,
- 'count' => $count,
- );
- }
- /**
- * Get users that match the search parameters.
- *
- * Searches on username, display name, and profile fields
- *
- * @param string $hook Hook name
- * @param string $type Hook type
- * @param array $value Empty array
- * @param array $params Search parameters
- * @return array
- */
- function search_users_hook($hook, $type, $value, $params) {
- $db_prefix = elgg_get_config('dbprefix');
- $query = sanitise_string($params['query']);
- $params['joins'] = array(
- "JOIN {$db_prefix}users_entity ue ON e.guid = ue.guid",
- );
-
- // username and display name
- $fields = array('username', 'name');
- $where = search_get_where_sql('ue', $fields, $params, FALSE);
- // profile fields
- $profile_fields = array_keys(elgg_get_config('profile_fields'));
-
- if (!empty($profile_fields)) {
- $params['joins'][] = "JOIN {$db_prefix}metadata md on e.guid = md.entity_guid";
- $params['joins'][] = "JOIN {$db_prefix}metastrings msv ON n_table.value_id = msv.id";
-
- // get the where clauses for the md names
- // can't use egef_metadata() because the n_table join comes too late.
- $clauses = _elgg_entities_get_metastrings_options('metadata', array(
- 'metadata_names' => $profile_fields,
- // avoid notices
- 'metadata_values' => null,
- 'metadata_name_value_pairs' => null,
- 'metadata_name_value_pairs_operator' => null,
- 'metadata_case_sensitive' => null,
- 'order_by_metadata' => null,
- 'metadata_owner_guids' => null,
- ));
-
- $params['joins'] = array_merge($clauses['joins'], $params['joins']);
- // no fulltext index, can't disable fulltext search in this function.
- // $md_where .= " AND " . search_get_where_sql('msv', array('string'), $params, FALSE);
- $md_where = "(({$clauses['wheres'][0]}) AND msv.string LIKE '%$query%')";
-
- $params['wheres'] = array("(($where) OR ($md_where))");
- } else {
- $params['wheres'] = array("$where");
- }
-
- // override subtype -- All users should be returned regardless of subtype.
- $params['subtype'] = ELGG_ENTITIES_ANY_VALUE;
- $params['count'] = true;
- $count = elgg_get_entities($params);
- // no need to continue if nothing here.
- if (!$count) {
- return array('entities' => array(), 'count' => $count);
- }
-
- $params['count'] = FALSE;
- $params['order_by'] = search_get_order_by_sql('e', 'ue', $params['sort'], $params['order']);
- $entities = elgg_get_entities($params);
- // add the volatile data for why these entities have been returned.
- foreach ($entities as $entity) {
-
- $title = search_get_highlighted_relevant_substrings($entity->name, $query);
- // include the username if it matches but the display name doesn't.
- if (false !== strpos($entity->username, $query)) {
- $username = search_get_highlighted_relevant_substrings($entity->username, $query);
- $title .= " ($username)";
- }
- $entity->setVolatileData('search_matched_title', $title);
- if (!empty($profile_fields)) {
- $matched = '';
- foreach ($profile_fields as $md_name) {
- $metadata = $entity->$md_name;
- if (is_array($metadata)) {
- foreach ($metadata as $text) {
- if (stristr($text, $query)) {
- $matched .= elgg_echo("profile:{$md_name}") . ': '
- . search_get_highlighted_relevant_substrings($text, $query);
- }
- }
- } else {
- if (stristr($metadata, $query)) {
- $matched .= elgg_echo("profile:{$md_name}") . ': '
- . search_get_highlighted_relevant_substrings($metadata, $query);
- }
- }
- }
-
- $entity->setVolatileData('search_matched_description', $matched);
- }
- }
- return array(
- 'entities' => $entities,
- 'count' => $count,
- );
- }
- /**
- * Get entities with tags that match the search parameters.
- *
- * @param string $hook Hook name
- * @param string $type Hook type
- * @param array $value Empty array
- * @param array $params Search parameters
- * @return array
- */
- function search_tags_hook($hook, $type, $value, $params) {
- $db_prefix = elgg_get_config('dbprefix');
- $valid_tag_names = elgg_get_registered_tag_metadata_names();
- // @todo will need to split this up to support searching multiple tags at once.
- $query = sanitise_string($params['query']);
- // if passed a tag metadata name, only search on that tag name.
- // tag_name isn't included in the params because it's specific to
- // tag searches.
- if ($tag_names = get_input('tag_names')) {
- if (is_array($tag_names)) {
- $search_tag_names = $tag_names;
- } else {
- $search_tag_names = array($tag_names);
- }
- // check these are valid to avoid arbitrary metadata searches.
- foreach ($search_tag_names as $i => $tag_name) {
- if (!in_array($tag_name, $valid_tag_names)) {
- unset($search_tag_names[$i]);
- }
- }
- } else {
- $search_tag_names = $valid_tag_names;
- }
- if (!$search_tag_names) {
- return array('entities' => array(), 'count' => $count);
- }
- // don't use elgg_get_entities_from_metadata() here because of
- // performance issues. since we don't care what matches at this point
- // use an IN clause to grab everything that matches at once and sort
- // out the matches later.
- $params['joins'][] = "JOIN {$db_prefix}metadata md on e.guid = md.entity_guid";
- $params['joins'][] = "JOIN {$db_prefix}metastrings msn on md.name_id = msn.id";
- $params['joins'][] = "JOIN {$db_prefix}metastrings msv on md.value_id = msv.id";
- $access = _elgg_get_access_where_sql(array('table_alias' => 'md'));
- $sanitised_tags = array();
- foreach ($search_tag_names as $tag) {
- $sanitised_tags[] = '"' . sanitise_string($tag) . '"';
- }
- $tags_in = implode(',', $sanitised_tags);
- $params['wheres'][] = "(msn.string IN ($tags_in) AND msv.string = '$query' AND $access)";
- $params['count'] = TRUE;
- $count = elgg_get_entities($params);
- // no need to continue if nothing here.
- if (!$count) {
- return array('entities' => array(), 'count' => $count);
- }
-
- $params['count'] = FALSE;
- $params['order_by'] = search_get_order_by_sql('e', null, $params['sort'], $params['order']);
- $entities = elgg_get_entities($params);
- // add the volatile data for why these entities have been returned.
- foreach ($entities as $entity) {
- $matched_tags_strs = array();
- // get tags for each tag name requested to find which ones matched.
- foreach ($search_tag_names as $tag_name) {
- $tags = $entity->getTags($tag_name);
- // @todo make one long tag string and run this through the highlight
- // function. This might be confusing as it could chop off
- // the tag labels.
- if (in_array(strtolower($query), array_map('strtolower', $tags))) {
- if (is_array($tags)) {
- $tag_name_str = elgg_echo("tag_names:$tag_name");
- $matched_tags_strs[] = "$tag_name_str: " . implode(', ', $tags);
- }
- }
- }
- // different entities have different titles
- switch($entity->type) {
- case 'site':
- case 'user':
- case 'group':
- $title_tmp = $entity->name;
- break;
- case 'object':
- $title_tmp = $entity->title;
- break;
- }
- // Nick told me my idea was dirty, so I'm hard coding the numbers.
- $title_tmp = strip_tags($title_tmp);
- if (elgg_strlen($title_tmp) > 297) {
- $title_str = elgg_substr($title_tmp, 0, 297) . '...';
- } else {
- $title_str = $title_tmp;
- }
- $desc_tmp = strip_tags($entity->description);
- if (elgg_strlen($desc_tmp) > 297) {
- $desc_str = elgg_substr($desc_tmp, 0, 297) . '...';
- } else {
- $desc_str = $desc_tmp;
- }
- $tags_str = implode('. ', $matched_tags_strs);
- $tags_str = search_get_highlighted_relevant_substrings($tags_str, $params['query'], 30, 300, true);
- $entity->setVolatileData('search_matched_title', $title_str);
- $entity->setVolatileData('search_matched_description', $desc_str);
- $entity->setVolatileData('search_matched_extra', $tags_str);
- }
- return array(
- 'entities' => $entities,
- 'count' => $count,
- );
- }
- /**
- * Register tags as a custom search type.
- *
- * @param string $hook Hook name
- * @param string $type Hook type
- * @param array $value Array of custom search types
- * @param array $params Search parameters
- * @return array
- */
- function search_custom_types_tags_hook($hook, $type, $value, $params) {
- $value[] = 'tags';
- return $value;
- }
|