File Source for Engine.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch_Search
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* @todo Write apidoc.
*
* @category MediaSearch
* @package MediaSearch_Search
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
class MediaSearch_Search_Engine implements Countable {
const TRACE_LEVEL = 51;
const MOVIES = 1;
const MUSIC = 2;
const SOFTWARE = 4;
const ALL = 7;
private $include;
private $query;
private $foundKeyWords;
private $hitList;
private $rankList;
private $searchResult;
public function __construct() {
$this->setInclude();
$this->reset();
}
public function setInclude($int = null) {
if (null === $int) {
$this->include = 0;
return;
}
if (!is_int($int) || $int < 1 || $int > self::ALL) {
$message = 'As include variable only a value between 1 ';
$message .= self::ALL . ' is allowed (Bitfield)!';
throw new InvalidArgumentException($message);
}
MediaSearch_Log::debug('Set inclusion with: ', array($int));
$this->include = $this->include | $int;
}
public function setQuery(MediaSearch_Search_Query $q) {
$this->query = $q;
}
public function search() {
$this->reset();
if ($this->query->isEmpty()) {
/**
* @todo Random search einbauen
*/
return;
}
$query = $this->query->get();
MediaSearch_Log::debug('prepared query:', array($query));
$keyWords = new MediaSearch_Model_KeyWord();
$result = $keyWords->findByKeyWords($query);
$this->processSearchResult($result);
}
public function getResults() {
return $this->searchResult;
}
public function count() {
return count($this->searchResult);
}
public function hasResults() {
return !empty($this->searchResult);
}
public function toArray() {
$results = array();
if ($this->hasResults()) {
foreach ($this->getResults() as $fileMeta) {
$results[] = $fileMeta->toArray(false);
}
}
return $results;
}
private function reset() {
MediaSearch_Log::trace('Resetting search!', self::TRACE_LEVEL);
$this->foundKeyWords = array();
$this->hitList = array();
$this->rankList = array();
$this->searchResult = array();
}
private function processSearchResult($resultsArray) {
if (empty($resultsArray)) {
return;
}
foreach ($resultsArray as $resultsSet) {
$this->addFoundKeyWords($resultsSet);
}
MediaSearch_Log::debug('Found keywords: ', array($this->foundKeyWords));
$this->generateHitList();
$this->generateRankList();
$this->loadFileInfo();
}
private function addFoundKeyWords($resultSet) {
if (!$resultSet->getKeyWord()) {
MediaSearch_Log::warn('Doesnt have the "keyWord" in resultset!');
// MediaSearch_Log::debug('resultset: ', $resultSet);
return;
}
$keyWord = strtolower($resultSet->getKeyWord());
if (!array_key_exists($keyWord, $this->foundKeyWords)) {
$this->foundKeyWords[$keyWord] = array();
}
$this->addFileMetaIdsToFoundKeys($keyWord, $resultSet);
}
private function addFileMetaIdsToFoundKeys($keyWord, $resultSet) {
if (!$resultSet->getFileMetaIds()) {
MediaSearch_Log::warn('Doesnt have the "FileMetaIds" in resultset!');
// MediaSearch_Log::debug('resultset: ', $resultSet);
return;
}
foreach ($resultSet->getFileMetaIds() as $id) {
$this->foundKeyWords[$keyWord][] = $id;
}
}
private function generateHitList() {
foreach ($this->foundKeyWords as $fileMetaIds) {
$this->addFileMetaIdsToHitList($fileMetaIds);
}
}
private function addFileMetaIdsToHitList($fileMetaIds) {
foreach ($fileMetaIds as $id) {
if (!array_key_exists($id, $this->hitList)) {
$this->hitList[$id] = 0;
}
$this->hitList[$id] += 1;
}
}
private function generateRankList() {
$tmpRankList = array();
foreach ($this->hitList as $fileMetaId => $hitCount) {
if (!array_key_exists($hitCount, $tmpRankList)) {
$tmpRankList[$hitCount] = array();
}
$tmpRankList[$hitCount][] = $fileMetaId;
}
$rankIds = array_keys($tmpRankList);
rsort($rankIds);
foreach ($rankIds as $rankId) {
$this->rankList = array_merge($this->rankList, $tmpRankList[$rankId]);
}
}
private function loadFileInfo() {
MediaSearch_Log::trace('Loading file infos...', self::TRACE_LEVEL);
$fileMeta = new MediaSearch_Model_FileMeta();
$types = $this->determineFileTypes();
MediaSearch_Log::debug('Including file types.', array($types));
$searchResult = $fileMeta->findByIdAndTypes($this->rankList, $types);
foreach ($searchResult as $fileMetaData) {
$fileMeta = new MediaSearch_Scan_FileMeta();
$fileMeta->fromObject($fileMetaData);
$rank = array_search($fileMetaData->getId(), $this->rankList);
$this->searchResult[$rank] = $fileMeta;
ksort($this->searchResult);
}
}
private function determineFileTypes() {
MediaSearch_Log::trace('Determining file inclusions for: ' . $this->include);
$types = array();
if (($this->include & self::MOVIES) === self::MOVIES) {
MediaSearch_Log::trace('Including movies.');
$types[] = MediaSearch_File_File::TYPE_MOVIE;
}
if (($this->include & self::MUSIC) === self::MUSIC) {
MediaSearch_Log::trace('Including music.');
$types[] = MediaSearch_File_File::TYPE_MUSIC;
}
if (($this->include & self::SOFTWARE) === self::SOFTWARE) {
MediaSearch_Log::trace('Including software.');
$types[] = MediaSearch_File_File::TYPE_SOFTWARE;
}
return $types;
}
}

Source for file Engine.php