File Source for ScannerApplication.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 Console_Application
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* AbstractDbApplication
*
* @see AbstractDbApplication
*/
require_once('AbstractDbApplication.php');
/**
* MediaSearch_File_TreeFactory
*
* @see MediaSearch_File_TreeFactory
*/
require_once('MediaSearch/File/TreeFactory.php');
/**
* MediaSearch_File_Visitor
*
* @see MediaSearch_File_Visitor
*/
require_once('MediaSearch/File/Visitor.php');
/**
* MediaSearch_Filter_KeyWords_PathRemover
*
* @see MediaSearch_Filter_KeyWords_PathRemover
*/
require_once('MediaSearch/Filter/KeyWords/PathRemover.php');
/**
* Neequired to react on signals
* @link http://de.php.net/manual/en/function.pcntl-signal.php
*/
declare(ticks = 1);
/**
* Scanns the given directory recursivle and gathers file meta informations.
*
* @see AbstractDbApplication
*
* @abstract
* @category MediaSearch
* @package Console_Application
* @uses MediaSearch_File_TreeFactory
* @uses MediaSearch_File_Visitor
* @uses MediaSearch_Model_FileMeta
* @uses MediaSearch_Log
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
class ScannerApplication extends AbstractDbApplication {
const TRACE_LELVEL = 7;
/**
* The directory which will be scanned.
*
* @access private
* @var string
*/
private $scanningDir;
/**
* Flags identify if the table will be truncated before save.
*
* @access private
* @var bool
*/
private $clearFileMetaTable = false;
/**
* Counts how much files are scanned.
*
* @access private
* @var int
*/
private $scannedFilesCnt = 0;
/**
* Generates a file tree and fisits it after that to
* gather meta information.
*
* @see Console_Application_Abstract::run()
*
* @access protected
*/
protected function run() {
$fileTree = $this->generateTree();
$scannedList = $this->visitTree($fileTree);
$this->clearFileMetaTable();
$this->saveData($scannedList);
}
/**
* @see AbstractDbApplication::getUsage()
*/
protected function tearDown() {
parent::tearDown();
$this->echoMsg($this->scannedFilesCnt . ' files scanned.');
$this->echoMsg('Meta data saved in database.');
}
/**
* Listen to option -d with a following string which is the scanned
* directory. Also listen to -c to clear the file meta table beforre
* saving.
*
* @see Console_Application_Abstract::findConsoleParameters()
*
* @access protected
* @throws Console_Exception_MissingParameter
* @return bool
*/
protected function findConsoleParameters() {
if (!parent::findConsoleParameters()) {
return false;
}
$options = getopt('d:c');
if (!isset($options['d']) || empty($options['d'])) {
require_once('Console/Exception/MissingParameter.php');
$message = 'You ommited the parameter -d for the scanning directory!';
throw new Console_Exception_MissingParameter($message);
}
$this->scanningDir = $options['d'];
if (!is_readable($this->scanningDir)) {
require_once('Console/Exception/MissingParameter.php');
$message = 'The given directory ' . $this->scanningDir;
$message .= 'is not readable!';
throw new Console_Exception_MissingParameter($message);
}
if (!is_dir($this->scanningDir)) {
require_once('Console/Exception/MissingParameter.php');
$message = 'The given directory ' . $this->scanningDir;
$message .= 'is not a directory!';
throw new Console_Exception_MissingParameter($message);
}
MediaSearch_Filter_KeyWords_PathRemover::$basePath = $this->scanningDir;
if (isset($options['c'])) {
$this->clearFileMetaTable = true;
}
return true;
}
/**
* Checks if the clear file meta table flag is set true and
* executes a truncate table.
*
* @access private
*/
private function clearFileMetaTable() {
if ($this->clearFileMetaTable) {
MediaSearch_Log::info('Clearing table FileMeta...');
$dbAdapter = $this->dbResource->getDbAdapter();
$dbAdapter->getConnection()->exec('TRUNCATE TABLE FileMeta');
}
}
/**
* Utilizes MediaSearch_File_TreeFactory to creates a file tree.
*
* @access private
* @return MediaSearch_File_Folder
*/
private function generateTree() {
MediaSearch_Log::info("Reading file tree of {$this->scanningDir} ...");
$treeFactory = new MediaSearch_File_TreeFactory($this->scanningDir);
$fileTree = $treeFactory->construct();
MediaSearch_Log::info('Tree generated.');
return $fileTree;
}
/**
* Visits the file tree with MediaSearch_File_Visitor to perform
* data gathering on the files.
*
* @access private
* @param MediaSearch_File_Folder $fileTree
* @return MediaSearch_Scan_List
*/
private function visitTree(MediaSearch_File_Folder $fileTree) {
MediaSearch_Log::info('Start scanning ...');
$visitor = new MediaSearch_File_Visitor();
$visitor->visit($fileTree);
MediaSearch_Log::info('Scan finished.');
return $visitor->getFileList();
}
/**
* Saves the gathered file meta data to the database.
*
* @access private
* @param MediaSearch_Scan_List $scannedList
*/
private function saveData(MediaSearch_Scan_List $scannedList) {
MediaSearch_Log::info('Saving scanned data...');
$count = 0;
foreach ($scannedList as $fileMeta) {
echo '.';
$fileMetaModel = new MediaSearch_Model_FileMeta();
$fileMetaModel->setOptions($fileMeta->toArray());
$fileMetaModel->setLastUpdate(time());
$fileMetaModel->save();
$count++;
}
$this->echoMsg();
MediaSearch_Log::info('');
MediaSearch_Log::info("Data saved ($count).");
$this->scannedFilesCnt = $count;
}
/**
* @see Console_Application_Abstract::getUsage()
*/
public function getUsage($options = null) {
return parent::getUsage('-d DIRECTORY -c');
}
/**
* @see Console_Application_Abstract::getHelpMessage()
*/
public function getHelpMessage($author = 'Sven Strittmatter', $email = 'ich@weltraumschaf.de') {
$message = 'This script scanns a given directory for the containing ';
$message .= 'media files.' . PHP_EOL;
$message .= PHP_EOL;
$message .= $this->getUsage() . ':' . PHP_EOL;
$message .= "\t{$this->scriptname} -d : The scanned directory" . PHP_EOL;
$message .= "\t{$this->scriptname} -c : The index table is cleared. ';
$message .= 'Before indexing starts." . PHP_EOL;
$message .= PHP_EOL;
$message .= parent::getHelpMessage($author, $email);
throw new Console_Exception($message);
}

Source for file ScannerApplication.php