From: Marcel Werk Date: Mon, 20 May 2013 23:00:09 +0000 (+0200) Subject: Merged com.woltlab.wcf.search into WCF X-Git-Tag: 2.0.0_Beta_1~119 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=749cca086ee11d039d96f9d96edf5be9ca6e5c39;p=GitHub%2FWoltLab%2FWCF.git Merged com.woltlab.wcf.search into WCF --- diff --git a/com.woltlab.wcf/objectTypeDefinition.xml b/com.woltlab.wcf/objectTypeDefinition.xml index 2596592e8c..2a5d72bfb4 100644 --- a/com.woltlab.wcf/objectTypeDefinition.xml +++ b/com.woltlab.wcf/objectTypeDefinition.xml @@ -114,5 +114,10 @@ com.woltlab.wcf.tagging.taggableObject wcf\system\tagging\ITaggable + + + com.woltlab.wcf.searchableObjectType + wcf\system\search\ISearchableObjectType + diff --git a/com.woltlab.wcf/option.xml b/com.woltlab.wcf/option.xml index e9a602c187..fe2fd27934 100644 --- a/com.woltlab.wcf/option.xml +++ b/com.woltlab.wcf/option.xml @@ -177,6 +177,10 @@ message + + + message + @@ -1023,6 +1027,35 @@ DESC:wcf.global.sortOrder.descending]]> 255 + + + + + + diff --git a/com.woltlab.wcf/template/header.tpl b/com.woltlab.wcf/template/header.tpl index 63cdb2585a..322f5df1b2 100644 --- a/com.woltlab.wcf/template/header.tpl +++ b/com.woltlab.wcf/template/header.tpl @@ -13,7 +13,7 @@ {/hascontent} - {event name='searchArea'} + {include file='searchArea'} diff --git a/com.woltlab.wcf/template/search.tpl b/com.woltlab.wcf/template/search.tpl new file mode 100644 index 0000000000..86e58b73fb --- /dev/null +++ b/com.woltlab.wcf/template/search.tpl @@ -0,0 +1,147 @@ +{include file='documentHeader'} + + + {lang}wcf.search.title{/lang} - {PAGE_TITLE|language} + + {include file='headInclude'} + + + + +{include file='header'} + +

{lang}wcf.search.title{/lang}

+ +{include file='userNotice'} + +{if $errorField} +

{lang}wcf.global.form.error{/lang}

+{/if} + +{if $errorMessage|isset} +

{@$errorMessage}

+{/if} + +

+ {lang}wcf.search.general{/lang} + + +

{lang}wcf.search.query{/lang}

+ + {if $errorField == 'q'} + + {if $errorType == 'empty'} + {lang}wcf.global.form.error.empty{/lang} + {else} + {lang}wcf.search.query.error.{@$errorType}{/lang} + {/if} + + {/if} + {lang}wcf.search.subjectOnly{/lang} + {event name='queryOptions'} + +

{lang}wcf.search.query.description{/lang}

+ + +

{lang}wcf.search.author{/lang}: + + {lang}wcf.search.matchExactly{/lang} + {event name='authorOptions'} +

+ +

{lang}wcf.search.period{/lang}: + + + {event name='periodOptions'} +

+ +

{lang}wcf.search.sortBy{/lang}: + + + + {event name='displayOptions'} +

+ + {event name='generalFields'} + +

{lang}wcf.search.type{/lang}: + {foreach from=$objectTypes key=objectTypeName item=objectType} + {if $objectType->isAccessible()} + {lang}wcf.search.type.{@$objectTypeName}{/lang} + {/if} + {/foreach} +

+ + {event name='fieldsets'} + {if $useCaptcha}{include file='recaptcha'}{/if} + + {foreach from=$objectTypes key=objectTypeName item=objectType} + {if $objectType->isAccessible() && $objectType->getFormTemplateName()} + {assign var='__jsID' value='.'|str_replace:'_':$objectTypeName} +

+ {lang}wcf.search.type.{@$objectTypeName}{/lang} + + {include file=$objectType->getFormTemplateName() application=$objectType->getApplication()} + + +

+ {/if} + {/foreach} +

+ +

+ +{include file='footer'} + + + + + \ No newline at end of file diff --git a/com.woltlab.wcf/template/searchArea.tpl b/com.woltlab.wcf/template/searchArea.tpl new file mode 100644 index 0000000000..8cd2752e44 --- /dev/null +++ b/com.woltlab.wcf/template/searchArea.tpl @@ -0,0 +1,35 @@ +{capture assign='__searchFormLink'}{link controller='Search'}{/link}{/capture} +{capture assign='__searchInputPlaceholder'}{lang}wcf.global.search.enterSearchTerm{/lang}{/capture} +{capture assign='__searchDropdownOptions'} {lang}wcf.search.subjectOnly{/lang}{/capture} +{assign var='__searchHiddenInputFields' value=''} + +{event name='settings'} + + + + + \ No newline at end of file diff --git a/com.woltlab.wcf/template/searchResult.tpl b/com.woltlab.wcf/template/searchResult.tpl new file mode 100644 index 0000000000..aca7cf64c1 --- /dev/null +++ b/com.woltlab.wcf/template/searchResult.tpl @@ -0,0 +1,60 @@ +{include file='documentHeader'} + + + {lang}wcf.search.results{/lang} - {PAGE_TITLE|language} + + {include file='headInclude'} + + + + +{include file='header'} + +

{if $query}{lang}wcf.search.results{/lang}{else}{lang}wcf.search.results{/lang}{/if}

{lang}wcf.search.results.description{/lang}

+ +{include file='userNotice'} + +

+ {assign var=encodedHighlight value=$highlight|urlencode} + {pages print=true assign=pagesLinks controller='SearchResult' id=$searchID link="pageNo=%d&highlight=$encodedHighlight"} + + {hascontent} + + {/hascontent} +

+ +{include file=$resultListTemplateName application=$resultListApplication} + +

+ {@$pagesLinks} + + {hascontent} + + {/hascontent} +

+ +{include file='footer'} + + + \ No newline at end of file diff --git a/com.woltlab.wcf/template/searchResultList.tpl b/com.woltlab.wcf/template/searchResultList.tpl new file mode 100644 index 0000000000..162a53837c --- /dev/null +++ b/com.woltlab.wcf/template/searchResultList.tpl @@ -0,0 +1,25 @@ +

+
+ {@$message->getUserProfile()->getAvatar()->getImageTag(48)} + +
+
+
{$message->getSubject()}
+
+ {$message->getUserProfile()->username} + - {@$message->getTime()|time} + {if $message->getContainerTitle()}- {$message->getContainerTitle()}{/if} +
+ {lang}wcf.search.object.{@$message->getObjectTypeName()}{/lang} +
+ +
{@$message->getFormattedMessage()}
+
+
+

\ No newline at end of file diff --git a/wcfsetup/install/files/js/WCF.Search.Message.js b/wcfsetup/install/files/js/WCF.Search.Message.js new file mode 100644 index 0000000000..98eac69bf0 --- /dev/null +++ b/wcfsetup/install/files/js/WCF.Search.Message.js @@ -0,0 +1,124 @@ +/** + * Namespace + */ +WCF.Search.Message = {}; + +/** + * Provides quick search for search keywords. + * + * @see WCF.Search.Base + */ +WCF.Search.Message.KeywordList = WCF.Search.Base.extend({ + /** + * @see WCF.Search.Base._className + */ + _className: 'wcf\\data\\search\\keyword\\SearchKeywordAction', + + /** + * dropdown divider + * @var jQuery + */ + _divider: null, + + /** + * true, if submit should be forced + * @var boolean + */ + _forceSubmit: false, + + /** + * @see WCF.Search.Base.init() + */ + init: function(searchInput, callback, excludedSearchValues) { + if (!$.isFunction(callback)) { + console.debug("[WCF.Search.Message.KeywordList] The given callback is invalid, aborting."); + return; + } + + this._callback = callback; + this._excludedSearchValues = []; + if (excludedSearchValues) { + this._excludedSearchValues = excludedSearchValues; + } + this._searchInput = $(searchInput).keyup($.proxy(this._keyUp, this)).keydown($.proxy(function(event) { + // block form submit + if (event.which === 13) { + // ... unless there are no suggestions + if (this._itemCount) { + event.preventDefault(); + } + } + }, this)); + + var $dropdownMenu = this._searchInput.next('.dropdownMenu'); + var $lastDivider = $dropdownMenu.find('li.dropdownDivider').last(); + this._divider = $('

').hide().insertBefore($lastDivider); + this._list = $('

').hide().insertBefore($lastDivider); + + // supress clicks on checkboxes + $dropdownMenu.find('input, label').on('click', function(event) { event.stopPropagation(); }); + + this._proxy = new WCF.Action.Proxy({ + showLoadingOverlay: false, + success: $.proxy(this._success, this) + }); + }, + + /** + * @see WCF.Search.Base._createListItem() + */ + _createListItem: function(item) { + this._divider.show(); + this._list.show(); + + this._super(item); + }, + + /** + * @see WCF.Search.Base._clearList() + */ + _clearList: function(clearSearchInput) { + if (clearSearchInput) { + this._searchInput.val(''); + } + + this._divider.hide(); + this._list.hide().empty(); + + WCF.CloseOverlayHandler.removeCallback('WCF.Search.Base'); + + // reset item navigation + this._itemCount = 0; + this._itemIndex = -1; + } +}); + +/** + * + */ +WCF.Search.Message.SearchArea = Class.extend({ + _searchArea: null, + + init: function(searchArea) { + this._searchArea = searchArea; + + new WCF.Search.Message.KeywordList(this._searchArea.find('input[type=search]'), $.proxy(this._callback, this)); + + // forward clicks on the search icon to input field + var self = this; + var $input = this._searchArea.find('input[type=search]'); + this._searchArea.click(function(event) { + // only forward clicks if the search element itself is the target + if (event.target == self._searchArea[0]) { + $input.focus().trigger('click'); + return false; + } + }); + }, + + _callback: function(data) { + this._searchArea.find('input[type=search]').val(data.label); + this._searchArea.find('input[type=search]').focus(); + return false; + } +}); \ No newline at end of file diff --git a/wcfsetup/install/files/js/WCF.Search.Message.min.js b/wcfsetup/install/files/js/WCF.Search.Message.min.js new file mode 100644 index 0000000000..01b03fd4fc --- /dev/null +++ b/wcfsetup/install/files/js/WCF.Search.Message.min.js @@ -0,0 +1 @@ +WCF.Search.Message={};WCF.Search.Message.KeywordList=WCF.Search.Base.extend({_className:"wcf\\data\\search\\keyword\\SearchKeywordAction",_divider:null,_forceSubmit:false,init:function(c,e,b){if(!$.isFunction(e)){console.debug("[WCF.Search.Message.KeywordList] The given callback is invalid, aborting.");return}this._callback=e;this._excludedSearchValues=[];if(b){this._excludedSearchValues=b}this._searchInput=$(c).keyup($.proxy(this._keyUp,this)).keydown($.proxy(function(f){if(f.which===13){if(this._itemCount){f.preventDefault()}}},this));var a=this._searchInput.next(".dropdownMenu");var d=a.find("li.dropdownDivider").last();this._divider=$('

').hide().insertBefore(d);this._list=$('

').hide().insertBefore(d);a.find("input, label").on("click",function(f){f.stopPropagation()});this._proxy=new WCF.Action.Proxy({showLoadingOverlay:false,success:$.proxy(this._success,this)})},_createListItem:function(a){this._divider.show();this._list.show();this._super(a)},_clearList:function(a){if(a){this._searchInput.val("")}this._divider.hide();this._list.hide().empty();WCF.CloseOverlayHandler.removeCallback("WCF.Search.Base");this._itemCount=0;this._itemIndex=-1}});WCF.Search.Message.SearchArea=Class.extend({_searchArea:null,init:function(b){this._searchArea=b;new WCF.Search.Message.KeywordList(this._searchArea.find("input[type=search]"),$.proxy(this._callback,this));var a=this;var c=this._searchArea.find("input[type=search]");this._searchArea.click(function(d){if(d.target==a._searchArea[0]){c.focus().trigger("click");return false}})},_callback:function(a){this._searchArea.find("input[type=search]").val(a.label);this._searchArea.find("input[type=search]").focus();return false}}); \ No newline at end of file diff --git a/wcfsetup/install/files/lib/data/search/ISearchResultObject.class.php b/wcfsetup/install/files/lib/data/search/ISearchResultObject.class.php new file mode 100644 index 0000000000..fc5649ba65 --- /dev/null +++ b/wcfsetup/install/files/lib/data/search/ISearchResultObject.class.php @@ -0,0 +1,73 @@ + + * @package com.woltlab.wcf.search + * @subpackage data.search + * @category Community Framework + */ +interface ISearchResultObject { + /** + * Returns author's user profile. + * + * @return wcf\data\user\UserProfile + */ + public function getUserProfile(); + + /** + * Returns the subject of this object. + * + * @return string + */ + public function getSubject(); + + /** + * Returns the creation time. + * + * @return integer + */ + public function getTime(); + + /** + * Returns the link to this object. + * + * @param string $query search query + * @return string + */ + public function getLink($query = ''); + + /** + * Returns the object type name. + * + * @return string + */ + public function getObjectTypeName(); + + /** + * Returns the message text. + * + * @return string + */ + public function getFormattedMessage(); + + /** + * Returns the title of object's container. Returns empty string if there + * is no container. + * + * @return string + */ + public function getContainerTitle(); + + /** + * Returns the link to object's container. Returns empty string if there + * is no container. + * + * @return string + */ + public function getContainerLink(); +} diff --git a/wcfsetup/install/files/lib/data/search/keyword/SearchKeyword.class.php b/wcfsetup/install/files/lib/data/search/keyword/SearchKeyword.class.php new file mode 100644 index 0000000000..c3ffa5b4fc --- /dev/null +++ b/wcfsetup/install/files/lib/data/search/keyword/SearchKeyword.class.php @@ -0,0 +1,25 @@ + + * @package com.woltlab.wcf.search + * @subpackage data.search.keyword + * @category Community Framework + */ +class SearchKeyword extends DatabaseObject { + /** + * @see wcf\data\DatabaseObject::$databaseTableName + */ + protected static $databaseTableName = 'search_keyword'; + + /** + * @see wcf\data\DatabaseObject::$databaseTableIndexName + */ + protected static $databaseTableIndexName = 'keywordID'; +} diff --git a/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php new file mode 100644 index 0000000000..328025f957 --- /dev/null +++ b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php @@ -0,0 +1,58 @@ + + * @package com.woltlab.wcf.search + * @subpackage data.search.keyword + * @category Community Framework + */ +class SearchKeywordAction extends AbstractDatabaseObjectAction implements ISearchAction { + /** + * @see wcf\data\AbstractDatabaseObjectAction::$className + */ + protected $className = 'wcf\data\search\keyword\SearchKeywordEditor'; + + /** + * @see wcf\data\AbstractDatabaseObjectAction::$allowGuestAccess + */ + protected $allowGuestAccess = array('getSearchResultList'); + + /** + * @see wcf\data\ISearchAction::validateGetSearchResultList() + */ + public function validateGetSearchResultList() { + $this->readString('searchString', false, 'data'); + } + + /** + * @see wcf\data\ISearchAction::getSearchResultList() + */ + public function getSearchResultList() { + $list = array(); + + // find users + $sql = "SELECT * + FROM wcf".WCF_N."_search_keyword + WHERE keyword LIKE ? + ORDER BY searches DESC"; + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute(array($this->parameters['data']['searchString'].'%')); + while ($row = $statement->fetchArray()) { + $list[] = array( + 'label' => $row['keyword'], + 'objectID' => $row['keywordID'] + ); + } + + return $list; + } +} diff --git a/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordEditor.class.php b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordEditor.class.php new file mode 100644 index 0000000000..a93ba977b6 --- /dev/null +++ b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordEditor.class.php @@ -0,0 +1,20 @@ + + * @package com.woltlab.wcf.search + * @subpackage data.search.keyword + * @category Community Framework + */ +class SearchKeywordEditor extends DatabaseObjectEditor { + /** + * @see wcf\data\DatabaseObjectDecorator::$baseClass + */ + protected static $baseClass = 'wcf\data\search\keyword\SearchKeyword'; +} diff --git a/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordList.class.php b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordList.class.php new file mode 100644 index 0000000000..c84989fca4 --- /dev/null +++ b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordList.class.php @@ -0,0 +1,20 @@ + + * @package com.woltlab.wcf.search + * @subpackage data.search.keyword + * @category Community Framework + */ +class SearchKeywordList extends DatabaseObjectList { + /** + * @see wcf\data\DatabaseObjectList::$className + */ + public $className = 'wcf\data\search\keyword\SearchKeyword'; +} diff --git a/wcfsetup/install/files/lib/form/SearchForm.class.php b/wcfsetup/install/files/lib/form/SearchForm.class.php new file mode 100644 index 0000000000..f30cc02896 --- /dev/null +++ b/wcfsetup/install/files/lib/form/SearchForm.class.php @@ -0,0 +1,465 @@ + + * @package com.woltlab.wcf.search + * @subpackage form + * @category Community Framework + */ +class SearchForm extends RecaptchaForm { + /** + * list of additional conditions + * @var array + */ + public $additionalConditions = array(); + + /** + * end date + * @var integer + */ + public $endDate = ''; + + /** + * true, if search should be modified + * @var boolean + */ + public $modifySearch = null; + + /** + * search id used for modification + * @var integer + */ + public $modifySearchID = 0; + + /** + * require exact matches + * @var integer + */ + public $nameExactly = 1; + + /** + * search query + * @var string + */ + public $query = ''; + + /** + * list of search results + * @var array + */ + public $results = array(); + + /** + * @see wcf\page\SortablePage::$sortField + */ + public $sortField = SEARCH_DEFAULT_SORT_FIELD; + + /** + * @see wcf\page\SortablePage::$sortOrder + */ + public $sortOrder = SEARCH_DEFAULT_SORT_ORDER; + + /** + * user id + * @var integer + */ + public $userID = 0; + + /** + * username + * @var string + */ + public $username = ''; + + /** + * @see wcf\form\RecaptchaForm::$useCaptcha + */ + public $useCaptcha = SEARCH_USE_CAPTCHA; + + /** + * parameters used for previous search + * @var array + */ + public $searchData = array(); + + /** + * search id + * @var integer + */ + public $searchID = 0; + + /** + * PreparedStatementConditionBuilder object + * @var wcf\system\database\util\PreparedStatementConditionBuilder + */ + public $searchIndexCondition = null; + + /** + * search hash to modify existing search + * @var string + */ + public $searchHash = ''; + + /** + * selected object types + * @var array + */ + public $selectedObjectTypes = array(); + + /** + * start date + * @var integer + */ + public $startDate = ''; + + /** + * search for subject only + * @var integer + */ + public $subjectOnly = 0; + + /** + * mark as submitted form if modifying search + * @var boolean + */ + public $submit = false; + + /** + * @see wcf\page\IPage::readParameters() + */ + public function readParameters() { + parent::readParameters(); + + if (isset($_REQUEST['q'])) $this->query = StringUtil::trim($_REQUEST['q']); + if (isset($_REQUEST['username'])) $this->username = StringUtil::trim($_REQUEST['username']); + if (isset($_REQUEST['userID'])) $this->userID = intval($_REQUEST['userID']); + if (isset($_REQUEST['types']) && is_array($_REQUEST['types'])) $this->selectedObjectTypes = $_REQUEST['types']; + $this->submit = (!empty($_POST) || !empty($this->query) || !empty($this->username) || $this->userID); + + if (isset($_REQUEST['modify'])) { + $this->modifySearchID = intval($_REQUEST['modify']); + $this->modifySearch = new Search($this->modifySearchID); + + if (!$this->modifySearch->searchID || ($this->modifySearch->userID && $this->modifySearch->userID != WCF::getUser()->userID)) { + throw new IllegalLinkException(); + } + + $this->searchData = unserialize($this->modifySearch->searchData); + if (empty($this->searchData['alterable'])) { + throw new IllegalLinkException(); + } + $this->query = $this->searchData['query']; + $this->sortOrder = $this->searchData['sortOrder']; + $this->sortField = $this->searchData['sortField']; + $this->nameExactly = $this->searchData['nameExactly']; + $this->subjectOnly = $this->searchData['subjectOnly']; + $this->startDate = $this->searchData['startDate']; + $this->endDate = $this->searchData['endDate']; + $this->username = $this->searchData['username']; + $this->userID = $this->searchData['userID']; + $this->selectedObjectTypes = $this->searchData['selectedObjectTypes']; + + if (!empty($_POST)) { + $this->submit = true; + } + } + + // sort order + if (isset($_REQUEST['sortField'])) { + $this->sortField = $_REQUEST['sortField']; + } + + switch ($this->sortField) { + case 'subject': + case 'time': + case 'username': break; + case 'relevance': if (!$this->submit || !empty($this->query)) break; + default: + if (!$this->submit || !empty($this->query)) $this->sortField = 'relevance'; + else $this->sortField = 'time'; + } + + if (isset($_REQUEST['sortOrder'])) { + $this->sortOrder = $_REQUEST['sortOrder']; + switch ($this->sortOrder) { + case 'ASC': + case 'DESC': break; + default: $this->sortOrder = 'DESC'; + } + } + } + + /** + * @see wcf\form\IForm::readFormParameters() + */ + public function readFormParameters() { + parent::readFormParameters(); + + $this->nameExactly = 0; + if (isset($_POST['nameExactly'])) $this->nameExactly = intval($_POST['nameExactly']); + if (isset($_POST['subjectOnly'])) $this->subjectOnly = intval($_POST['subjectOnly']); + if (isset($_POST['startDate'])) $this->startDate = $_POST['startDate']; + if (isset($_POST['endDate'])) $this->endDate = $_POST['endDate']; + } + + /** + * @see wcf\form\IForm::validate() + */ + public function validate() { + parent::validate(); + + // get search conditions + $this->getConditions(); + + // check query and author + if (empty($this->query) && empty($this->username) && !$this->userID) { + throw new UserInputException('q'); + } + + // build search hash + $this->searchHash = StringUtil::getHash(serialize(array($this->query, $this->selectedObjectTypes, !$this->subjectOnly, $this->searchIndexCondition, $this->additionalConditions, $this->sortField.' '.$this->sortOrder, PACKAGE_ID))); + + // check search hash + if (!empty($this->query)) { + $parameters = array($this->searchHash, 'messages', TIME_NOW - 1800); + if (WCF::getUser()->userID) $parameters[] = WCF::getUser()->userID; + + $sql = "SELECT searchID + FROM wcf".WCF_N."_search + WHERE searchHash = ? + AND searchType = ? + AND searchTime > ? + ".(WCF::getUser()->userID ? 'AND userID = ?' : 'AND userID IS NULL'); + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute($parameters); + $row = $statement->fetchArray(); + if ($row !== false) { + HeaderUtil::redirect(LinkHandler::getInstance()->getLink('SearchResult', array('id' => $row['searchID']), 'highlight='.urlencode($this->query))); + exit; + } + } + + // do search + $this->results = SearchEngine::getInstance()->search($this->query, $this->selectedObjectTypes, $this->subjectOnly, $this->searchIndexCondition, $this->additionalConditions, $this->sortField.' '.$this->sortOrder); + + // result is empty + if (empty($this->results)) { + $this->throwNoMatchesException(); + } + } + + /** + * Throws a NamedUserException on search failure. + */ + public function throwNoMatchesException() { + if (empty($this->query)) { + throw new NamedUserException(WCF::getLanguage()->get('wcf.search.error.user.noMatches')); + } + else { + throw new NamedUserException(WCF::getLanguage()->getDynamicVariable('wcf.search.error.noMatches', array('query' => $this->query))); + } + } + + /** + * @see wcf\form\IForm::save() + */ + public function save() { + parent::save(); + + // get additional data + $additionalData = array(); + foreach (SearchEngine::getInstance()->getAvailableObjectTypes() as $objectTypeName => $objectType) { + if (($data = $objectType->getAdditionalData()) !== null) { + $additionalData[$objectTypeName] = $data; + } + } + + // save result in database + $this->searchData = array( + 'packageID' => PACKAGE_ID, + 'query' => $this->query, + 'results' => $this->results, + 'additionalData' => $additionalData, + 'sortField' => $this->sortField, + 'sortOrder' => $this->sortOrder, + 'nameExactly' => $this->nameExactly, + 'subjectOnly' => $this->subjectOnly, + 'startDate' => $this->startDate, + 'endDate' => $this->endDate, + 'username' => $this->username, + 'userID' => $this->userID, + 'selectedObjectTypes' => $this->selectedObjectTypes, + 'alterable' => (!$this->userID ? 1 : 0) + ); + if ($this->modifySearchID) { + $this->objectAction = new SearchAction(array($this->modifySearchID), 'update', array('data' => array( + 'searchData' => serialize($this->searchData), + 'searchTime' => TIME_NOW, + 'searchType' => 'messages', + 'searchHash' => $this->searchHash + ))); + $this->objectAction->executeAction(); + } + else { + $this->objectAction = new SearchAction(array(), 'create', array('data' => array( + 'userID' => (WCF::getUser()->userID ?: null), + 'searchData' => serialize($this->searchData), + 'searchTime' => TIME_NOW, + 'searchType' => 'messages', + 'searchHash' => $this->searchHash + ))); + $resultValues = $this->objectAction->executeAction(); + $this->searchID = $resultValues['returnValues']->searchID; + } + // save keyword + if (!empty($this->query)) { + SearchKeywordManager::getInstance()->add($this->query); + } + $this->saved(); + + // forward to result page + HeaderUtil::redirect(LinkHandler::getInstance()->getLink('SearchResult', array('id' => $this->searchID), 'highlight='.urlencode($this->query))); + exit; + } + + /** + * @see wcf\page\IPage::assignVariables() + */ + public function assignVariables() { + parent::assignVariables(); + + // init form + foreach (SearchEngine::getInstance()->getAvailableObjectTypes() as $objectType) $objectType->show($this); + + WCF::getTPL()->assign(array( + 'query' => $this->query, + 'subjectOnly' => $this->subjectOnly, + 'username' => $this->username, + 'nameExactly' => $this->nameExactly, + 'startDate' => $this->startDate, + 'endDate' => $this->endDate, + 'sortField' => $this->sortField, + 'sortOrder' => $this->sortOrder, + 'selectedObjectTypes' => $this->selectedObjectTypes, + 'objectTypes' => SearchEngine::getInstance()->getAvailableObjectTypes() + )); + } + + /** + * @see wcf\page\IPage::show() + */ + public function show() { + if (empty($_POST) && $this->submit) { + if ($this->userID) $this->useCaptcha = false; + $this->submit(); + } + + parent::show(); + } + + /** + * Gets the conditions for a search in the table of the selected object types. + */ + protected function getConditions() { + if (empty($this->selectedObjectTypes)) { + $this->selectedObjectTypes = array_keys(SearchEngine::getInstance()->getAvailableObjectTypes()); + } + + // default conditions + $userIDs = $this->getUserIDs(); + $this->searchIndexCondition = new PreparedStatementConditionBuilder(false); + + // user ids + if (!empty($userIDs)) { + $this->searchIndexCondition->add('userID IN (?)', array($userIDs)); + } + + // dates + if (($startDate = @strtotime($this->startDate)) && ($endDate = @strtotime($this->endDate))) { + $this->searchIndexCondition->add('time BETWEEN ? AND ?', array($startDate, $endDate)); + } + + // language + if (LanguageFactory::getInstance()->multilingualismEnabled() && count(WCF::getUser()->getLanguageIDs())) { + $this->searchIndexCondition->add('(languageID IN (?) OR languageID IS NULL)', array(WCF::getUser()->getLanguageIDs())); + } + + foreach ($this->selectedObjectTypes as $key => $objectTypeName) { + $objectType = SearchEngine::getInstance()->getObjectType($objectTypeName); + if ($objectType === null) { + throw new SystemException('unknown search object type '.$objectTypeName); + } + + try { + if (!$objectType->isAccessible()) { + throw new PermissionDeniedException(); + } + + // special conditions + if (($conditionBuilder = $objectType->getConditions($this)) !== null) { + $this->additionalConditions[$objectTypeName] = $conditionBuilder; + } + } + catch (PermissionDeniedException $e) { + unset($this->selectedObjectTypes[$key]); + continue; + } + } + + if (empty($this->selectedObjectTypes)) { + $this->throwNoMatchesException(); + } + } + + /** + * Returns user ids. + * + * @return array + */ + public function getUserIDs() { + $userIDs = array(); + + // username + if (!empty($this->username)) { + $sql = "SELECT userID + FROM wcf".WCF_N."_user + WHERE username ".($this->nameExactly ? "= ?" : "LIKE ?"); + $statement = WCF::getDB()->prepareStatement($sql, 100); + $statement->execute(array($this->username.(!$this->nameExactly ? '%' : ''))); + while ($row = $statement->fetchArray()) { + $userIDs[] = $row['userID']; + } + + if (empty($userIDs)) { + $this->throwNoMatchesException(); + } + } + + // userID + if ($this->userID) { + $userIDs[] = $this->userID; + } + + return $userIDs; + } +} diff --git a/wcfsetup/install/files/lib/page/SearchResultPage.class.php b/wcfsetup/install/files/lib/page/SearchResultPage.class.php new file mode 100644 index 0000000000..a26fe7e41c --- /dev/null +++ b/wcfsetup/install/files/lib/page/SearchResultPage.class.php @@ -0,0 +1,181 @@ + + * @package com.woltlab.wcf.search + * @subpackage page + * @category Community Framework + */ +class SearchResultPage extends MultipleLinkPage { + /** + * @see wcf\page\MultipleLinkPage::$itemsPerPage + */ + public $itemsPerPage = SEARCH_RESULTS_PER_PAGE; + + /** + * highlight string + * @var string + */ + public $highlight = ''; + + /** + * search id + * @var integer + */ + public $searchID = 0; + + /** + * search object + * @var wcf\data\search\Search + */ + public $search = null; + + /** + * messages + * @var array + */ + public $messages = array(); + + /** + * search data + * @var array + */ + public $searchData = null; + + /** + * result list template + * @var string + */ + public $resultListTemplateName = 'searchResultList'; + + /** + * result list template's application + * @var string + */ + public $resultListApplication = 'wcf'; + + /** + * @see wcf\page\IPage::readParameters() + */ + public function readParameters() { + parent::readParameters(); + + if (isset($_REQUEST['highlight'])) $this->highlight = $_REQUEST['highlight']; + if (isset($_REQUEST['id'])) $this->searchID = intval($_REQUEST['id']); + $this->search = new Search($this->searchID); + if (!$this->search->searchID || $this->search->searchType != 'messages') { + throw new IllegalLinkException(); + } + if ($this->search->userID && $this->search->userID != WCF::getUser()->userID) { + throw new IllegalLinkException(); + } + + // get search data + $this->searchData = unserialize($this->search->searchData); + + // check package id of this search + if (!empty($this->searchData['packageID']) && $this->searchData['packageID'] != PACKAGE_ID) { + throw new IllegalLinkException(); + } + } + + /** + * @see wcf\page\IPage::readData() + */ + public function readData() { + parent::readData(); + + // cache message data + $this->cacheMessageData(); + + // get messages + $this->readMessages(); + } + + /** + * Caches the message data. + */ + protected function cacheMessageData() { + $types = array(); + + // group object id by object type + for ($i = $this->startIndex - 1; $i < $this->endIndex; $i++) { + $type = $this->searchData['results'][$i]['objectType']; + $objectID = $this->searchData['results'][$i]['objectID']; + + if (!isset($types[$type])) $types[$type] = array(); + $types[$type][] = $objectID; + } + + foreach ($types as $type => $objectIDs) { + $objectType = SearchEngine::getInstance()->getObjectType($type); + $objectType->cacheObjects($objectIDs, (isset($this->searchData['additionalData'][$type]) ? $this->searchData['additionalData'][$type] : null)); + } + } + + /** + * Gets the data of the messages. + */ + protected function readMessages() { + for ($i = $this->startIndex - 1; $i < $this->endIndex; $i++) { + $type = $this->searchData['results'][$i]['objectType']; + $objectID = $this->searchData['results'][$i]['objectID']; + + $objectType = SearchEngine::getInstance()->getObjectType($type); + if (($message = $objectType->getObject($objectID)) !== null) { + $this->messages[] = $message; + } + } + } + + /** + * @see wcf\page\IPage::assignVariables() + */ + public function assignVariables() { + parent::assignVariables(); + + WCF::getTPL()->assign(array( + 'query' => $this->searchData['query'], + 'objects' => $this->messages, + 'searchData' => $this->searchData, + 'searchID' => $this->searchID, + 'highlight' => $this->highlight, + 'sortField' => $this->searchData['sortField'], + 'sortOrder' => $this->searchData['sortOrder'], + 'alterable' => (!empty($this->searchData['alterable']) ? 1 : 0), + 'objectTypes' => SearchEngine::getInstance()->getAvailableObjectTypes(), + 'resultListTemplateName' => $this->resultListTemplateName, + 'resultListApplication' => $this->resultListApplication + )); + } + + /** + * @see wcf\page\MultipleLinkPage::countItems() + */ + public function countItems() { + // call countItems event + EventHandler::getInstance()->fireAction($this, 'countItems'); + + return count($this->searchData['results']); + } + + /** + * @see wcf\page\MultipleLinkPage::initObjectList() + */ + protected function initObjectList() { } + + /** + * @see wcf\page\MultipleLinkPage::readObjects() + */ + protected function readObjects() { } +} diff --git a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php index 4970b011c0..d0ae11a5c6 100644 --- a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php +++ b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php @@ -22,6 +22,22 @@ class DailyCleanUpCronjob extends AbstractCronjob { public function execute(Cronjob $cronjob) { parent::execute($cronjob); + // clean up search keywords + $sql = "SELECT AVG(searches) AS searches + FROM wcf".WCF_N."_search_keyword"; + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute(); + if (($row = $statement->fetchArray()) !== false) { + $sql = "DELETE FROM wcf".WCF_N."_search_keyword + WHERE searches <= ? + AND lastSearchTime < ?"; + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute(array( + floor($row['searches'] / 4), + (TIME_NOW - 86400 * 30) + )); + } + // clean up notifications $sql = "DELETE FROM wcf".WCF_N."_user_notification WHERE time < ?"; diff --git a/wcfsetup/install/files/lib/system/search/AbstractSearchableObjectType.class.php b/wcfsetup/install/files/lib/system/search/AbstractSearchableObjectType.class.php new file mode 100644 index 0000000000..ae29d2ff84 --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/AbstractSearchableObjectType.class.php @@ -0,0 +1,92 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +abstract class AbstractSearchableObjectType extends AbstractObjectTypeProcessor implements ISearchableObjectType { + /** + * @see wcf\system\search\ISearchableObjectType::show() + */ + public function show(IForm $form = null) {} + + /** + * @see wcf\system\search\ISearchableObjectType::getApplication() + */ + public function getApplication() { + return 'wcf'; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getConditions() + */ + public function getConditions(IForm $form = null) { + return null; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getJoins() + */ + public function getJoins() { + return ''; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getSubjectFieldName() + */ + public function getSubjectFieldName() { + return $this->getTableName().'.subject'; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getUsernameFieldName() + */ + public function getUsernameFieldName() { + return $this->getTableName().'.username'; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getTimeFieldName() + */ + public function getTimeFieldName() { + return $this->getTableName().'.time'; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getAdditionalData() + */ + public function getAdditionalData() { + return null; + } + + /** + * @see wcf\system\search\ISearchableObjectType::isAccessible() + */ + public function isAccessible() { + return true; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getFormTemplateName() + */ + public function getFormTemplateName() { + return ''; + } + + /** + * @see wcf\system\search\ISearchableObjectType::getSpecialSQLQuery() + */ + public function getSpecialSQLQuery(PreparedStatementConditionBuilder $fulltextCondition = null, PreparedStatementConditionBuilder $searchIndexConditions = null, PreparedStatementConditionBuilder $additionalConditions = null, $orderBy = 'time DESC') { + return ''; + } +} diff --git a/wcfsetup/install/files/lib/system/search/ISearchableObjectType.class.php b/wcfsetup/install/files/lib/system/search/ISearchableObjectType.class.php new file mode 100644 index 0000000000..01e96944df --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/ISearchableObjectType.class.php @@ -0,0 +1,128 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +interface ISearchableObjectType { + /** + * Caches the data for the given object ids. + * + * @param array $objectIDs + * @param array $additionalData + */ + public function cacheObjects(array $objectIDs, array $additionalData = null); + + /** + * Returns the object with the given object id. + * + * @param integer $objectID + * @return wcf\data\search\ISearchResultObject + */ + public function getObject($objectID); + + /** + * Shows the form part of this object type. + * + * @param wcf\form\IForm $form instance of the form class where the search has taken place + */ + public function show(IForm $form = null); + + /** + * Returns the application abbreviation. + * + * @return string + */ + public function getApplication(); + + /** + * Returns the search conditions of this message type. + * + * @param wcf\form\IForm $form + * @return wcf\system\database\util\PreparedStatementConditionBuilder + */ + public function getConditions(IForm $form = null); + + /** + * Provides the ability to add additional joins to sql search query. + * + * @return string + */ + public function getJoins(); + + /** + * Returns the database table name of this message. + * + * @return string + */ + public function getTableName(); + + /** + * Returns the database field name of the message id. + * + * @return string + */ + public function getIDFieldName(); + + /** + * Returns the database field name of the subject field. + * + * @return string + */ + public function getSubjectFieldName(); + + /** + * Returns the database field name of the username. + * + * @return string + */ + public function getUsernameFieldName(); + + /** + * Returns the database field name of the time. + * + * @return string + */ + public function getTimeFieldName(); + + /** + * Returns additional search information. + * + * @return mixed + */ + public function getAdditionalData(); + + /** + * Returns true if the current user can use this searchable object type. + * + * @return boolean + */ + public function isAccessible(); + + /** + * Returns the name of the form template for this object type. + * + * @return string + */ + public function getFormTemplateName(); + + /** + * Provides the option to replace the default search index SQL query by an own version. + * + * @param wcf\system\database\util\PreparedStatementConditionBuilder $fulltextCondition + * @param wcf\system\database\util\PreparedStatementConditionBuilder $searchIndexConditions + * @param wcf\system\database\util\PreparedStatementConditionBuilder $additionalConditions + * @param string $orderBy + * @return string + */ + public function getSpecialSQLQuery(PreparedStatementConditionBuilder $fulltextCondition = null, PreparedStatementConditionBuilder $searchIndexConditions = null, PreparedStatementConditionBuilder $additionalConditions = null, $orderBy = 'time DESC'); +} diff --git a/wcfsetup/install/files/lib/system/search/SearchEngine.class.php b/wcfsetup/install/files/lib/system/search/SearchEngine.class.php new file mode 100644 index 0000000000..b5f4b58bdb --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/SearchEngine.class.php @@ -0,0 +1,209 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +class SearchEngine extends SingletonFactory { + /** + * list of available object types + * @var array + */ + protected $availableObjectTypes = array(); + + /** + * @see wcf\system\SingletonFactory::init() + */ + protected function init() { + // get available object types + $this->availableObjectTypes = ObjectTypeCache::getInstance()->getObjectTypes('com.woltlab.wcf.searchableObjectType'); + + // get processors + foreach ($this->availableObjectTypes as &$objectType) { + $objectType = $objectType->getProcessor(); + } + } + + /** + * Returns a list of available object types. + * + * @return array + */ + public function getAvailableObjectTypes() { + return $this->availableObjectTypes; + } + + /** + * Returns the object type with the given name. + * + * @param string $objectTypeName + * @return wcf\data\object\type\ObjectType + */ + public function getObjectType($objectTypeName) { + if (isset($this->availableObjectTypes[$objectTypeName])) { + return $this->availableObjectTypes[$objectTypeName]; + } + + return null; + } + + /** + * Searches for the given string and returns the data of the found messages. + * + * @param string $q + * @param array $objectTypes + * @param boolean $subjectOnly + * @param wcf\system\database\util\PreparedStatementConditionBuilder $searchIndexCondition + * @param array $additionalConditions + * @param string $orderBy + * @param integer $limit + * @return array + */ + public function search($q, array $objectTypes, $subjectOnly = false, PreparedStatementConditionBuilder $searchIndexCondition = null, array $additionalConditions = array(), $orderBy = 'time DESC', $limit = 1000) { + // handle sql types + $fulltextCondition = null; + $relevanceCalc = ''; + if (!empty($q)) { + // expand search terms with a * unless they're encapsulated with quotes + $inQuotes = false; + $tmp = ''; + $controlCharacterOrSpace = false; + $chars = array('+', '-', '*'); + for ($i = 0, $length = StringUtil::length($q); $i < $length; $i++) { + $char = $q[$i]; + + if ($inQuotes) { + if ($char == '"') { + $inQuotes = false; + } + } + else { + if ($char == '"') { + $inQuotes = true; + } + else { + if ($char == ' ' && !$controlCharacterOrSpace) { + $controlCharacterOrSpace = true; + $tmp .= '*'; + } + else if (in_array($char, $chars)) { + $controlCharacterOrSpace = true; + } + else { + $controlCharacterOrSpace = false; + } + } + } + + $tmp .= $char; + } + + // handle last char + if (!$inQuotes && !$controlCharacterOrSpace) { + $tmp .= '*'; + } + $q = $tmp; + + $fulltextCondition = new PreparedStatementConditionBuilder(false); + switch (WCF::getDB()->getDBType()) { + case 'wcf\system\database\MySQLDatabase': + $fulltextCondition->add("MATCH (subject".(!$subjectOnly ? ', message, metaData' : '').") AGAINST (? IN BOOLEAN MODE)", array($q)); + break; + + case 'wcf\system\database\PostgreSQLDatabase': + // replace * with :* + $q = StringUtil::replace('*', ':*', $q); + + $fulltextCondition->add("fulltextIndex".($subjectOnly ? "SubjectOnly" : '')." @@ to_tsquery(?)", array($q)); + break; + + default: + throw new SystemException("your database type doesn't support fulltext search"); + } + + if ($orderBy == 'relevance ASC' || $orderBy == 'relevance DESC') { + switch (WCF::getDB()->getDBType()) { + case 'wcf\system\database\MySQLDatabase': + $relevanceCalc = "MATCH (subject".(!$subjectOnly ? ', message, metaData' : '').") AGAINST ('".escapeString($q)."') + (5 / (1 + POW(LN(1 + (".TIME_NOW." - time) / 2592000), 2))) AS relevance"; + break; + + case 'wcf\system\database\PostgreSQLDatabase': + $relevanceCalc = "ts_rank_cd(fulltextIndex".($subjectOnly ? "SubjectOnly" : '').", '".escapeString($q)."') AS relevance"; + break; + } + } + } + + // build search query + $sql = ''; + $parameters = array(); + foreach ($objectTypes as $objectTypeName) { + $objectType = $this->getObjectType($objectTypeName); + if (!empty($sql)) $sql .= "\nUNION\n"; + if (($specialSQL = $objectType->getSpecialSQLQuery($fulltextCondition, $searchIndexCondition, (isset($additionalConditions[$objectTypeName]) ? $additionalConditions[$objectTypeName] : null), $orderBy))) { + $sql .= "(".$specialSQL.")"; + } + else { + $sql .= "( + SELECT ".$objectType->getIDFieldName()." AS objectID, + ".$objectType->getSubjectFieldName()." AS subject, + ".$objectType->getTimeFieldName()." AS time, + ".$objectType->getUsernameFieldName()." AS username, + '".$objectTypeName."' AS objectType + ".($relevanceCalc ? ',search_index.relevance' : '')." + FROM ".$objectType->getTableName()." + INNER JOIN ( + SELECT objectID + ".($relevanceCalc ? ','.$relevanceCalc : '')." + FROM wcf".WCF_N."_search_index + WHERE ".($fulltextCondition !== null ? $fulltextCondition : '')." + ".(($searchIndexCondition !== null && $searchIndexCondition->__toString()) ? ($fulltextCondition !== null ? "AND " : '').$searchIndexCondition : '')." + AND objectTypeID = ".$objectType->objectTypeID." + ".(!empty($orderBy) && $fulltextCondition === null ? 'ORDER BY '.$orderBy : '')." + LIMIT 1000 + ) search_index + ON (".$objectType->getIDFieldName()." = search_index.objectID) + ".$objectType->getJoins()." + ".(isset($additionalConditions[$objectTypeName]) ? $additionalConditions[$objectTypeName] : '')." + )"; + } + + if ($fulltextCondition !== null) $parameters = array_merge($parameters, $fulltextCondition->getParameters()); + if ($searchIndexCondition !== null) $parameters = array_merge($parameters, $searchIndexCondition->getParameters()); + if (isset($additionalConditions[$objectTypeName])) $parameters = array_merge($parameters, $additionalConditions[$objectTypeName]->getParameters()); + } + if (empty($sql)) { + throw new SystemException('no object types given'); + } + + if (!empty($orderBy)) { + $sql .= " ORDER BY " . $orderBy; + } + + // send search query + $messages = array(); + $statement = WCF::getDB()->prepareStatement($sql, $limit); + $statement->execute($parameters); + while ($row = $statement->fetchArray()) { + $messages[] = array( + 'objectID' => $row['objectID'], + 'objectType' => $row['objectType'] + ); + } + + return $messages; + } +} diff --git a/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php b/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php new file mode 100644 index 0000000000..648e600642 --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php @@ -0,0 +1,113 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +class SearchIndexManager extends SingletonFactory { + /** + * list of available object types + * @var array + */ + protected $availableObjectTypes = array(); + + /** + * @see wcf\system\SingletonFactory::init() + */ + protected function init() { + // get available object types + $this->availableObjectTypes = ObjectTypeCache::getInstance()->getObjectTypes('com.woltlab.wcf.searchableObjectType'); + } + + /** + * Returns the id of the object type with the given name. + * + * @param string $objectType + * @return integer + */ + public function getObjectTypeID($objectType) { + if (!isset($this->availableObjectTypes[$objectType])) { + throw new SystemException("unknown object type '".$objectType."'"); + } + + return $this->availableObjectTypes[$objectType]->objectTypeID; + } + + /** + * Adds a new entry. + * + * @param string $objectType + * @param integer $objectID + * @param string $message + * @param string $subject + * @param integer $time + * @param integer $userID + * @param string $username + * @param integer $languageID + * @param string $metaData + */ + public function add($objectType, $objectID, $message, $subject, $time, $userID, $username, $languageID = null, $metaData = '') { + if ($languageID === null) $languageID = 0; + + // save new entry + $sql = "INSERT INTO wcf".WCF_N."_search_index + (objectTypeID, objectID, subject, message, time, userID, username, languageID, metaData) + VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)"; + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute(array($this->getObjectTypeID($objectType), $objectID, $subject, $message, $time, $userID, $username, $languageID, $metaData)); + } + + /** + * Updates the search index. + * + * @param string $objectType + * @param integer $objectID + * @param string $message + * @param string $subject + * @param integer $time + * @param integer $userID + * @param string $username + * @param integer $languageID + * @param string $metaData + */ + public function update($objectType, $objectID, $message, $subject, $time, $userID, $username, $languageID = null, $metaData = '') { + // delete existing entry + $this->delete($objectType, array($objectID), ($languageID === null ? 0 : $languageID)); + + // save new entry + $this->add($objectType, $objectID, $message, $subject, $time, $userID, $username, $languageID, $metaData); + } + + /** + * Deletes search index entries. + * + * @param string $objectType + * @param array $objectIDs + */ + public function delete($objectType, array $objectIDs) { + $objectTypeID = $this->getObjectTypeID($objectType); + + $sql = "DELETE FROM wcf".WCF_N."_search_index + WHERE objectTypeID = ? + AND objectID = ?"; + $statement = WCF::getDB()->prepareStatement($sql); + WCF::getDB()->beginTransaction(); + foreach ($objectIDs as $objectID) { + $parameters = array($objectTypeID, $objectID); + + $statement->execute($parameters); + } + WCF::getDB()->commitTransaction(); + } +} diff --git a/wcfsetup/install/files/lib/system/search/SearchKeywordManager.class.php b/wcfsetup/install/files/lib/system/search/SearchKeywordManager.class.php new file mode 100644 index 0000000000..f901b1d419 --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/SearchKeywordManager.class.php @@ -0,0 +1,60 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +class SearchKeywordManager extends SingletonFactory { + /** + * Adds the given keyword. + * + * @param string $keyword + */ + public function add($keyword) { + $keyword = static::simplifyKeyword($keyword); + + // search existing entry + $sql = "SELECT * + FROM wcf".WCF_N."_search_keyword + WHERE keyword = ?"; + $statement = WCF::getDB()->prepareStatement($sql); + $statement->execute(array($keyword)); + if (($object = $statement->fetchObject('wcf\data\search\keyword\SearchKeyword')) !== null) { + $action = new SearchKeywordAction(array($object), 'update', array('data' => array( + 'searches' => $object->searches + 1, + 'lastSearchTime' => TIME_NOW + ))); + $action->executeAction(); + } + else { + $action = new SearchKeywordAction(array(), 'create', array('data' => array( + 'keyword' => $keyword, + 'searches' => 1, + 'lastSearchTime' => TIME_NOW + ))); + $action->executeAction(); + } + } + + /** + * Returns simplified version of the given keyword. + * + * @param string $keyword + * @return string + */ + public static function simplifyKeyword($keyword) { + // TODO: do something useful + + return $keyword; + } +} diff --git a/wcfsetup/install/files/lib/system/search/SearchResultTextParser.class.php b/wcfsetup/install/files/lib/system/search/SearchResultTextParser.class.php new file mode 100644 index 0000000000..6e2e08f1d3 --- /dev/null +++ b/wcfsetup/install/files/lib/system/search/SearchResultTextParser.class.php @@ -0,0 +1,207 @@ + + * @package com.woltlab.wcf.search + * @subpackage system.search + * @category Community Framework + */ +class SearchResultTextParser extends SingletonFactory { + /** + * max length for message abstract + * @var integer + */ + const MAX_LENGTH = 500; + + /** + * highlight query + * @var mixed + */ + protected $searchQuery = ''; + + /** + * @see wcf\system\SingletonFactory::init() + */ + protected function init() { + if (isset($_GET['highlight'])) { + $keywordString = $_GET['highlight']; + + // remove search operators + $keywordString = preg_replace('/[\+\-><()~\*]+/', '', $keywordString); + + if (StringUtil::substring($keywordString, 0, 1) == '"' && StringUtil::substring($keywordString, -1) == '"') { + // phrases search + $keywordString = StringUtil::trim(StringUtil::substring($keywordString, 1, -1)); + + if (!empty($keywordString)) { + $this->searchQuery = $keywordString; + } + } + else { + $this->searchQuery = ArrayUtil::trim(explode(' ', $keywordString)); + if (empty($this->searchQuery)) { + $this->searchQuery = false; + } + else if (count($this->searchQuery) == 1) { + $this->searchQuery = reset($this->searchQuery); + } + } + } + } + + /** + * Returns an abstract of the given message. + * Uses search keywords to shift the start and end position of the abstract (like Google). + * + * @param string $text + * @return string + */ + protected function getMessageAbstract($text) { + // replace newlines with spaces + $text = Regex::compile("\s+")->replace($text, ' '); + + if (StringUtil::length($text) > static::MAX_LENGTH) { + if ($this->searchQuery) { + // phrase search + if (!is_array($this->searchQuery)) { + $start = StringUtil::indexOfIgnoreCase($text, $this->searchQuery); + if ($start !== false) { + $end = $start + StringUtil::length($this->searchQuery); + $shiftStartBy = $shiftEndBy = round((static::MAX_LENGTH - StringUtil::length($this->searchQuery)) / 2); + + // shiftStartBy is negative when search query length is over max length + if ($shiftStartBy < 0) { + $shiftEndBy += $shiftStartBy; + $shiftStartBy = 0; + } + + // shift abstract start + if ($start - $shiftStartBy < 0) { + $shiftEndBy += $shiftStartBy - $start; + $start = 0; + } + else { + $start -= $shiftStartBy; + } + + // shift abstract end + if ($end + $shiftEndBy > StringUtil::length($text) - 1) { + $shiftStartBy = $end + $shiftEndBy - StringUtil::length($text) - 1; + $shiftEndBy = 0; + if ($shiftStartBy > $start) { + $start = 0; + } + else { + $start -= $shiftStartBy; + } + } + else { + $end += $shiftEndBy; + } + + $newText = ''; + if ($start > 0) $newText .= StringUtil::HELLIP; + $newText .= StringUtil::substring($text, $start, $end - $start); + if ($end < StringUtil::length($text) - 1) $newText .= StringUtil::HELLIP; + return $newText; + } + } + else { + $matches = array(); + $shiftLength = static::MAX_LENGTH; + // find first match of each keyword + foreach ($this->searchQuery as $keyword) { + $start = StringUtil::indexOfIgnoreCase($text, $keyword); + if ($start !== false) { + $shiftLength -= StringUtil::length($keyword); + $matches[$keyword] = array('start' => $start, 'end' => $start + StringUtil::length($keyword)); + } + } + + // shift match position + $shiftBy = round(($shiftLength / count($this->searchQuery)) / 2); + foreach ($matches as $keyword => $position) { + $position['start'] -= $shiftBy; + $position['end'] += $shiftBy; + $matches[$keyword] = $position; + } + + $start = 0; + $end = StringUtil::length($text) - 1; + $newText = ''; + $i = 0; + $length = count($matches); + foreach ($matches as $keyword => $position) { + if ($position['start'] < $start) { + $position['end'] += $start - $position['start']; + $position['start'] = $start; + } + + if ($position['end'] > $end) { + if ($position['start'] > $start) { + $shiftStartBy = $position['end'] - $end; + if ($position['start'] - $shiftStartBy < $start) { + $shiftStartBy = $position['start'] - $start; + } + + $position['start'] -= $shiftStartBy; + } + + $position['end'] = $end; + } + + if ($position['start'] > $start) $newText .= StringUtil::HELLIP; + $newText .= StringUtil::substring($text, $position['start'], $position['end'] - $position['start']); + if ($i == $length - 1 && $position['end'] < $end) $newText .= StringUtil::HELLIP; + + $start = $position['end']; + $i++; + } + + if (!empty($newText)) return $newText; + } + } + + // no search query or no matches + return StringUtil::substring($text, 0, static::MAX_LENGTH) . StringUtil::HELLIP; + } + + return $text; + } + + /** + * Formats a message for search result output. + * + * @param string $text + * @return string + */ + public function parse($text) { + // remove nonessentials + $text = Regex::compile('.*?', Regex::DOT_ALL)->replace($text, ''); + + // remove html codes + $text = StringUtil::stripHTML($text); + + // decode html + $text = StringUtil::decodeHTML($text); + + // get abstract + $text = $this->getMessageAbstract($text); + + // encode html + $text = StringUtil::encodeHTML($text); + + // do highlighting + return KeywordHighlighter::getInstance()->doHighlight($text); + } +} diff --git a/wcfsetup/install/files/style/search.less b/wcfsetup/install/files/style/search.less new file mode 100644 index 0000000000..36c849b00c --- /dev/null +++ b/wcfsetup/install/files/style/search.less @@ -0,0 +1,5 @@ +.messageSearchResultList { + > li > .box48 > div > .containerHeadline > h3 { + padding-right: 100px; + } +} \ No newline at end of file diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml index ecdd50dd59..0c2d0f1b97 100644 --- a/wcfsetup/install/lang/de.xml +++ b/wcfsetup/install/lang/de.xml @@ -766,6 +766,11 @@ + + + + + @@ -1710,6 +1715,28 @@ Erlaubte Dateiendungen: {', '|implode:$attachmentHandler->getAllowedExtensions() + + + + + + + + + + + {$query}â{/if}.{if $items == 1000} Es gibt noch weitere Suchergebnisse, bitte verfeinern Sie Ihre Suche.{/if}{if $highlight}
Diese Suchbegriffe wurden hervorgehoben: {$highlight}{/if}]]> + + + + + + + + + + + diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml index 8e58246be1..6f8dd8811c 100644 --- a/wcfsetup/install/lang/en.xml +++ b/wcfsetup/install/lang/en.xml @@ -765,6 +765,11 @@ Examples for medium ID detection: + + + + + @@ -1708,6 +1713,28 @@ Allowed extensions: {', '|implode:$attachmentHandler->getAllowedExtensions()}]]> + + + + + + + + + + + {$query}â{/if}.{if $items == 1000} There are more results available, please enhance your search parameters.{/if}{if $highlight}
These terms were highlighted: {$highlight}{/if}]]> + + + + + + + + + + + diff --git a/wcfsetup/setup/db/install.sql b/wcfsetup/setup/db/install.sql index ed7b63cb48..facbcd0d04 100644 --- a/wcfsetup/setup/db/install.sql +++ b/wcfsetup/setup/db/install.sql @@ -712,6 +712,33 @@ CREATE TABLE wcf1_search ( KEY searchHash (searchHash) ); +DROP TABLE IF EXISTS wcf1_search_index; +CREATE TABLE wcf1_search_index ( + objectTypeID INT(10) NOT NULL, + objectID INT(10) NOT NULL, + subject VARCHAR(255) NOT NULL DEFAULT '', + message MEDIUMTEXT, + metaData MEDIUMTEXT, + time INT(10) NOT NULL DEFAULT 0, + userID INT(10), + username VARCHAR(255) NOT NULL DEFAULT '', + languageID INT(10), + UNIQUE KEY (objectTypeID, objectID), + FULLTEXT INDEX fulltextIndex (subject, message, metaData), + FULLTEXT INDEX fulltextIndexSubjectOnly (subject), + KEY (userID, objectTypeID, time) +); + +DROP TABLE IF EXISTS wcf1_search_keyword; +CREATE TABLE wcf1_search_keyword ( + keywordID INT(10) NOT NULL AUTO_INCREMENT PRIMARY KEY, + keyword VARCHAR(255) NOT NULL, + searches INT(10) NOT NULL DEFAULT 0, + lastSearchTime INT(10) NOT NULL DEFAULT 0, + UNIQUE KEY (keyword), + KEY (searches, lastSearchTime) +); + DROP TABLE IF EXISTS wcf1_session; CREATE TABLE wcf1_session ( sessionID CHAR(40) NOT NULL PRIMARY KEY, @@ -1450,6 +1477,8 @@ ALTER TABLE wcf1_tag_to_object ADD FOREIGN KEY (tagID) REFERENCES wcf1_tag (tagI ALTER TABLE wcf1_tag_to_object ADD FOREIGN KEY (languageID) REFERENCES wcf1_language (languageID) ON DELETE CASCADE; ALTER TABLE wcf1_tag_to_object ADD FOREIGN KEY (objectTypeID) REFERENCES wcf1_object_type (objectTypeID) ON DELETE CASCADE; +ALTER TABLE wcf1_search_index ADD FOREIGN KEY (objectTypeID) REFERENCES wcf1_object_type (objectTypeID) ON DELETE CASCADE; +ALTER TABLE wcf1_search_index ADD FOREIGN KEY (languageID) REFERENCES wcf1_language (languageID) ON DELETE SET NULL; /* default inserts */ -- default user groups

{$message->getSubject()}