mirror of
https://git.code.sf.net/p/seeddms/code
synced 2024-10-17 05:22:23 +00:00
240 lines
7.7 KiB
PHP
240 lines
7.7 KiB
PHP
<?php
|
|
/**
|
|
* Implementation of an indexed document
|
|
*
|
|
* @category DMS
|
|
* @package SeedDMS_Lucene
|
|
* @license GPL 2
|
|
* @version @version@
|
|
* @author Uwe Steinmann <uwe@steinmann.cx>
|
|
* @copyright Copyright (C) 2010, Uwe Steinmann
|
|
* @version Release: @package_version@
|
|
*/
|
|
|
|
|
|
/**
|
|
* Class for managing an indexed document.
|
|
*
|
|
* @category DMS
|
|
* @package SeedDMS_Lucene
|
|
* @version @version@
|
|
* @author Uwe Steinmann <uwe@steinmann.cx>
|
|
* @copyright Copyright (C) 2011, Uwe Steinmann
|
|
* @version Release: @package_version@
|
|
*/
|
|
class SeedDMS_Lucene_IndexedDocument extends Zend_Search_Lucene_Document {
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $errormsg;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $mimetype;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $cmd;
|
|
|
|
/**
|
|
* Run a shell command
|
|
*
|
|
* @param $cmd
|
|
* @param int $timeout
|
|
* @return array
|
|
* @throws Exception
|
|
*/
|
|
static function execWithTimeout($cmd, $timeout=2) { /* {{{ */
|
|
$descriptorspec = array(
|
|
0 => array("pipe", "r"),
|
|
1 => array("pipe", "w"),
|
|
2 => array("pipe", "w")
|
|
);
|
|
$pipes = array();
|
|
|
|
$timeout += time();
|
|
// Putting an 'exec' before the command will not fork the command
|
|
// and therefore not create any child process. proc_terminate will
|
|
// then reliably terminate the cmd and not just shell. See notes of
|
|
// https://www.php.net/manual/de/function.proc-terminate.php
|
|
$process = proc_open('exec '.$cmd, $descriptorspec, $pipes);
|
|
if (!is_resource($process)) {
|
|
throw new Exception("proc_open failed on: " . $cmd);
|
|
}
|
|
stream_set_blocking($pipes[1], 0);
|
|
stream_set_blocking($pipes[2], 0);
|
|
|
|
$output = $error = '';
|
|
$timeleft = $timeout - time();
|
|
$read = array($pipes[1], $pipes[2]);
|
|
$write = NULL;
|
|
$exeptions = NULL;
|
|
do {
|
|
$num_changed_streams = stream_select($read, $write, $exeptions, $timeleft, 200000);
|
|
|
|
if ($num_changed_streams === false) {
|
|
proc_terminate($process);
|
|
throw new Exception("stream select failed on: " . $cmd);
|
|
} elseif ($num_changed_streams > 0) {
|
|
$output .= fread($pipes[1], 8192);
|
|
$error .= fread($pipes[2], 8192);
|
|
}
|
|
$timeleft = $timeout - time();
|
|
} while (!feof($pipes[1]) && $timeleft > 0);
|
|
|
|
fclose($pipes[0]);
|
|
fclose($pipes[1]);
|
|
fclose($pipes[2]);
|
|
if ($timeleft <= 0) {
|
|
proc_terminate($process);
|
|
throw new Exception("command timeout on: " . $cmd);
|
|
} else {
|
|
$return_value = proc_close($process);
|
|
return array('stdout'=>$output, 'stderr'=>$error, 'return'=>$return_value);
|
|
}
|
|
} /* }}} */
|
|
|
|
/**
|
|
* Constructor. Creates our indexable document and adds all
|
|
* necessary fields to it using the passed in document
|
|
* @param SeedDMS_Core_DMS $dms
|
|
* @param SeedDMS_Core_Document|Folder $document
|
|
* @param null $convcmd
|
|
* @param bool $nocontent
|
|
* @param int $timeout
|
|
*/
|
|
public function __construct($dms, $document, $convcmd=null, $nocontent=false, $timeout=5) { /* {{{ */
|
|
$this->errormsg = '';
|
|
$this->cmd = '';
|
|
$this->mimetype = '';
|
|
|
|
$this->addField(Zend_Search_Lucene_Field::Text('title', $document->getName(), 'utf-8'));
|
|
if($acllist = $document->getReadAccessList(1, 1, 1)) {
|
|
$allu = [];
|
|
foreach($acllist['users'] as $u)
|
|
$allu[] = $u->getLogin();
|
|
$this->addField(Zend_Search_Lucene_Field::Text('users', implode(' ', $allu), 'utf-8'));
|
|
/*
|
|
$allg = [];
|
|
foreach($acllist['groups'] as $g)
|
|
$allg[] = $g->getName();
|
|
$this->addField(Zend_Search_Lucene_Field::Text('groups', implode(' ', $allg), 'utf-8'));
|
|
*/
|
|
}
|
|
if($attributes = $document->getAttributes()) {
|
|
foreach($attributes as $attribute) {
|
|
$attrdef = $attribute->getAttributeDefinition();
|
|
if($attrdef->getValueSet() != '')
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('attr_'.str_replace(' ', '_', $attrdef->getName()), $attribute->getValue(), 'utf-8'));
|
|
else
|
|
$this->addField(Zend_Search_Lucene_Field::Text('attr_'.str_replace(' ', '_', $attrdef->getName()), $attribute->getValue(), 'utf-8'));
|
|
}
|
|
}
|
|
$owner = $document->getOwner();
|
|
$this->addField(Zend_Search_Lucene_Field::Text('owner', $owner->getLogin(), 'utf-8'));
|
|
if($comment = $document->getComment()) {
|
|
$this->addField(Zend_Search_Lucene_Field::Text('comment', $comment, 'utf-8'));
|
|
}
|
|
$tmp = explode(':', substr($document->getFolderList(), 1, -1));
|
|
foreach($tmp as $t)
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('path', $t));
|
|
// $this->addField(Zend_Search_Lucene_Field::Keyword('path', str_replace(':', 'x', $document->getFolderList())));
|
|
|
|
if($document->isType('document')) {
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('document_id', 'D'.$document->getID()));
|
|
$version = $document->getLatestContent();
|
|
if($version) {
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('mimetype', $version->getMimeType()));
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('origfilename', $version->getOriginalFileName(), 'utf-8'));
|
|
if(!$nocontent)
|
|
$this->addField(Zend_Search_Lucene_Field::UnIndexed('created', $version->getDate()));
|
|
if($attributes = $version->getAttributes()) {
|
|
foreach($attributes as $attribute) {
|
|
$attrdef = $attribute->getAttributeDefinition();
|
|
if($attrdef->getValueSet() != '')
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('attr_'.str_replace(' ', '_', $attrdef->getName()), $attribute->getValue(), 'utf-8'));
|
|
else
|
|
$this->addField(Zend_Search_Lucene_Field::Text('attr_'.str_replace(' ', '_', $attrdef->getName()), $attribute->getValue(), 'utf-8'));
|
|
}
|
|
}
|
|
}
|
|
if($categories = $document->getCategories()) {
|
|
$names = array();
|
|
foreach($categories as $cat) {
|
|
$names[] = $cat->getName();
|
|
}
|
|
$this->addField(Zend_Search_Lucene_Field::Text('category', implode(' ', $names), 'utf-8'));
|
|
}
|
|
|
|
if($keywords = $document->getKeywords()) {
|
|
$this->addField(Zend_Search_Lucene_Field::Text('keywords', $keywords, 'utf-8'));
|
|
}
|
|
if($version) {
|
|
$status = $version->getStatus();
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('status', $status['status'], 'utf-8'));
|
|
}
|
|
if($version && !$nocontent) {
|
|
$path = $dms->contentDir . $version->getPath();
|
|
if(file_exists($path)) {
|
|
$content = '';
|
|
$mimetype = $version->getMimeType();
|
|
$this->mimetype = $mimetype;
|
|
$cmd = '';
|
|
$mimeparts = explode('/', $mimetype, 2);
|
|
if(isset($convcmd[$mimetype])) {
|
|
$cmd = sprintf($convcmd[$mimetype], $path);
|
|
} elseif(isset($convcmd[$mimeparts[0].'/*'])) {
|
|
$cmd = sprintf($convcmd[$mimetype], $path);
|
|
} elseif(isset($convcmd['*'])) {
|
|
$cmd = sprintf($convcmd[$mimetype], $path);
|
|
}
|
|
if($cmd) {
|
|
$this->cmd = $cmd;
|
|
try {
|
|
$content = self::execWithTimeout($cmd, $timeout);
|
|
if($content['stdout']) {
|
|
$this->addField(Zend_Search_Lucene_Field::UnStored('content', $content['stdout'], 'utf-8'));
|
|
}
|
|
if($content['stderr']) {
|
|
$this->errormsg = $content['stderr'];
|
|
}
|
|
} catch (Exception $e) {
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif($document->isType('folder')) {
|
|
$this->addField(Zend_Search_Lucene_Field::Keyword('document_id', 'F'.$document->getID()));
|
|
$this->addField(Zend_Search_Lucene_Field::UnIndexed('created', $document->getDate()));
|
|
}
|
|
} /* }}} */
|
|
|
|
public function getErrorMsg() { /* {{{ */
|
|
return $this->errormsg;
|
|
} /* }}} */
|
|
|
|
public function getMimeType() { /* {{{ */
|
|
return $this->mimetype;
|
|
} /* }}} */
|
|
|
|
public function setContent($data) { /* {{{ */
|
|
$this->addField(Zend_Search_Lucene_Field::UnStored('content', $data, 'utf-8'));
|
|
} /* }}} */
|
|
|
|
public function getCmd() { /* {{{ */
|
|
return $this->cmd;
|
|
} /* }}} */
|
|
|
|
/* Use only for setting the command if e.g. an extension takes over the
|
|
* conversion to txt (like the office extension which uses the collabora
|
|
* conversion service).
|
|
*/
|
|
public function setCmd($cmd) { /* {{{ */
|
|
$this->cmd = $cmd;
|
|
} /* }}} */
|
|
}
|
|
?>
|