mirror of
https://git.code.sf.net/p/seeddms/code
synced 2025-10-25 02:01:19 +00:00
295 lines
9.5 KiB
PHP
295 lines
9.5 KiB
PHP
<?php
|
|
|
|
require_once("inc/inc.ClassSchedulerTaskBase.php");
|
|
|
|
/**
|
|
* Class containing methods for running a scheduled task
|
|
*
|
|
* @author Uwe Steinmann <uwe@steinmann.cx>
|
|
* @package SeedDMS
|
|
* @subpackage core
|
|
*/
|
|
class SeedDMS_ExpiredDocumentsTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
|
|
|
|
/**
|
|
* Run the task
|
|
*
|
|
* @param $task task to be executed
|
|
* @param $dms dms
|
|
* @return boolean true if task was executed succesfully, otherwise false
|
|
*/
|
|
public function execute($task) {
|
|
$dms = $this->dms;
|
|
$user = $this->user;
|
|
$settings = $this->settings;
|
|
$logger = $this->logger;
|
|
$taskparams = $task->getParameter();
|
|
$docs = $dms->getDocumentsExpired(intval($taskparams['days']));
|
|
$tableformat = " %-10s %5d %-60s";
|
|
$tableformathead = " %-10s %5s %-60s";
|
|
$tableformathtml = "<tr><td>%s</td><td>%d</td><td>%s</td></tr>";
|
|
$tableformatheadhtml = "<tr><th>%s</th><th>%s</th><th>%s</th></tr>";
|
|
$body = '';
|
|
$bodyhtml = '';
|
|
if (count($docs)>0) {
|
|
$bodyhtml .= "<table>".PHP_EOL;
|
|
$bodyhtml .= sprintf($tableformatheadhtml."\n", getMLText("expiration_date", array(), ""), "ID", getMLText("name", array(), ""));
|
|
$body .= sprintf($tableformathead."\n", getMLText("expiration_date", array(), ""), "ID", getMLText("name", array(), ""));
|
|
$body .= "---------------------------------------------------------------------------------\n";
|
|
foreach($docs as $doc) {
|
|
$body .= sprintf($tableformat."\n", getReadableDate($doc->getExpires()), $doc->getId(), $doc->getName());
|
|
$bodyhtml .= sprintf($tableformathtml."\n", getReadableDate($doc->getExpires()), $doc->getId(), $doc->getName());
|
|
}
|
|
$bodyhtml .= "</table>".PHP_EOL;
|
|
if($taskparams['email'])
|
|
require_once('inc/inc.ClassEmailNotify.php');
|
|
$email = new SeedDMS_EmailNotify($dms, $settings->_smtpSendFrom, $settings->_smtpServer, $settings->_smtpPort, $settings->_smtpUser, $settings->_smtpPassword);
|
|
|
|
$params = array();
|
|
$params['count'] = count($docs);
|
|
$params['__body__'] = $body;
|
|
$params['__body_html__'] = $bodyhtml;
|
|
$params['sitename'] = $settings->_siteName;
|
|
$email->toIndividual('', $taskparams['email'], 'expired_docs_mail_subject', '', $params);
|
|
|
|
$logger->log('Task \'expired_docs\': Sending reminder \'expired_docs_mail_subject\' to user \''.$taskparams['email'].'\'', PEAR_LOG_INFO);
|
|
// mail($taskparams['email'], getMLText('expired_docs_mail_subject',array('sitename'=>$settings->_siteName, 'count'=>count($docs))), $body);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Check for expired documents and set the document status';
|
|
}
|
|
|
|
public function getAdditionalParams() {
|
|
return array(
|
|
array(
|
|
'name'=>'email',
|
|
'type'=>'string',
|
|
'description'=> '',
|
|
),
|
|
array(
|
|
'name'=>'days',
|
|
'type'=>'integer',
|
|
'description'=> 'Number of days to check for. Negative values will look into the past. 0 will just check for documents expiring the current day. Keep in mind that the document is still valid on the expiration date.',
|
|
)
|
|
);
|
|
}
|
|
} /* }}} */
|
|
|
|
/**
|
|
* Class for processing a single folder
|
|
*
|
|
* SeedDMS_Task_Indexer_Process_Folder::process() is used as a callable when
|
|
* iterating over all folders recursively.
|
|
*/
|
|
class SeedDMS_Task_Indexer_Process_Folder { /* {{{ */
|
|
protected $forceupdate;
|
|
|
|
protected $fulltextservice;
|
|
|
|
public function __construct($fulltextservice, $forceupdate) { /* {{{ */
|
|
$this->fulltextservice = $fulltextservice;
|
|
$this->forceupdate = $forceupdate;
|
|
} /* }}} */
|
|
|
|
public function process($folder) { /* {{{ */
|
|
$documents = $folder->getDocuments();
|
|
if($documents) {
|
|
$lucenesearch = $this->fulltextservice->Search();
|
|
echo $folder->getFolderPathPlain().PHP_EOL;
|
|
foreach($documents as $document) {
|
|
echo $document->getId().":".$document->getName()." ";
|
|
/* If the document wasn't indexed before then just add it */
|
|
if(!($hit = $lucenesearch->getDocument($document->getId()))) {
|
|
try {
|
|
$idoc = $this->fulltextservice->IndexedDocument($document, true);
|
|
if(isset($GLOBALS['SEEDDMS_HOOKS']['indexDocument'])) {
|
|
foreach($GLOBALS['SEEDDMS_HOOKS']['indexDocument'] as $hookObj) {
|
|
if (method_exists($hookObj, 'preIndexDocument')) {
|
|
$hookObj->preIndexDocument(null, $document, $idoc);
|
|
}
|
|
}
|
|
}
|
|
$this->fulltextservice->Indexer()->addDocument($idoc);
|
|
echo " (Document added)".PHP_EOL;
|
|
} catch(Exception $e) {
|
|
echo " (Timeout)".PHP_EOL;
|
|
}
|
|
} else {
|
|
/* Check if the attribute created is set or has a value older
|
|
* than the lastet content. Documents without such an attribute
|
|
* where added when a new document was added to the dms. In such
|
|
* a case the document content wasn't indexed.
|
|
*/
|
|
try {
|
|
$created = (int) $hit->getDocument()->getFieldValue('created');
|
|
} catch (/* Zend_Search_Lucene_ */Exception $e) {
|
|
$created = 0;
|
|
}
|
|
$content = $document->getLatestContent();
|
|
if($created >= $content->getDate() && !$this->forceupdate) {
|
|
echo getMLText('index_document_unchanged').PHP_EOL;
|
|
} else {
|
|
$this->fulltextservice->Indexer()->delete($hit->id);
|
|
try {
|
|
$idoc = $this->fulltextservice->IndexedDocument($document, true);
|
|
if(isset($GLOBALS['SEEDDMS_HOOKS']['indexDocument'])) {
|
|
foreach($GLOBALS['SEEDDMS_HOOKS']['indexDocument'] as $hookObj) {
|
|
if (method_exists($hookObj, 'preIndexDocument')) {
|
|
$hookObj->preIndexDocument(null, $document, $idoc);
|
|
}
|
|
}
|
|
}
|
|
$this->fulltextservice->Indexer()->addDocument($idoc);
|
|
echo " (Document updated)".PHP_EOL;
|
|
} catch(Exception $e) {
|
|
echo " (Timeout)".PHP_EOL;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} /* }}} */
|
|
} /* }}} */
|
|
|
|
/**
|
|
* Class containing methods for running a scheduled task
|
|
*
|
|
* @author Uwe Steinmann <uwe@steinmann.cx>
|
|
* @package SeedDMS
|
|
* @subpackage core
|
|
*/
|
|
class SeedDMS_IndexingDocumentsTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
|
|
|
|
/**
|
|
* Run the task
|
|
*
|
|
* @param $task task to be executed
|
|
* @param $dms dms
|
|
* @return boolean true if task was executed succesfully, otherwise false
|
|
*/
|
|
public function execute($task) {
|
|
$dms = $this->dms;
|
|
$logger = $this->logger;
|
|
$fulltextservice = $this->fulltextservice;
|
|
$taskparams = $task->getParameter();
|
|
$folder = $dms->getRootFolder();
|
|
$recreate = isset($taskparams['recreate']) ? $taskparams['recreate'] : false;
|
|
|
|
if($fulltextservice) {
|
|
if($recreate) {
|
|
$index = $fulltextservice->Indexer(true);
|
|
if(!$index) {
|
|
UI::exitError(getMLText("admin_tools"),getMLText("no_fulltextindex"));
|
|
}
|
|
} else {
|
|
$index = $fulltextservice->Indexer(false);
|
|
if(!$index) {
|
|
$index = $fulltextservice->Indexer(true);
|
|
if(!$index) {
|
|
UI::exitError(getMLText("admin_tools"),getMLText("no_fulltextindex"));
|
|
}
|
|
}
|
|
}
|
|
|
|
$folderprocess = new SeedDMS_Task_Indexer_Process_Folder($fulltextservice, $recreate);
|
|
$tree = new SeedDMS_FolderTree($folder, array($folderprocess, 'process'));
|
|
call_user_func(array($folderprocess, 'process'), $folder);
|
|
} else {
|
|
$logger->log('Task \'indexingdocs\': fulltext search is turned off', PEAR_LOG_WARNING);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Indexing all new or updated documents';
|
|
}
|
|
|
|
public function getAdditionalParams() {
|
|
return array(
|
|
array(
|
|
'name'=>'recreate',
|
|
'type'=>'boolean',
|
|
'description'=> 'Force recreation of index',
|
|
)
|
|
);
|
|
}
|
|
} /* }}} */
|
|
|
|
/**
|
|
* Class for processing a single folder
|
|
*
|
|
* SeedDMS_Task_CheckSum_Process_Folder::process() is used as a callable when
|
|
* iterating over all folders recursively.
|
|
*/
|
|
class SeedDMS_Task_CheckSum_Process_Folder { /* {{{ */
|
|
public function __construct() { /* {{{ */
|
|
} /* }}} */
|
|
|
|
public function process($folder) { /* {{{ */
|
|
$dms = $folder->getDMS();
|
|
$documents = $folder->getDocuments();
|
|
if($documents) {
|
|
foreach($documents as $document) {
|
|
$versions = $document->getContent();
|
|
foreach($versions as $version) {
|
|
if(file_exists($dms->contentDir.$version->getPath())) {
|
|
$checksum = SeedDMS_Core_File::checksum($dms->contentDir.$version->getPath());
|
|
if($checksum != $version->getChecksum()) {
|
|
echo $document->getId().':'.$version->getVersion().' wrong checksum'.PHP_EOL;
|
|
}
|
|
} else {
|
|
echo $document->getId().':'.$version->getVersion().' missing content'.PHP_EOL;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} /* }}} */
|
|
} /* }}} */
|
|
|
|
/**
|
|
* Class containing methods for running a scheduled task
|
|
*
|
|
* @author Uwe Steinmann <uwe@steinmann.cx>
|
|
* @package SeedDMS
|
|
* @subpackage core
|
|
*/
|
|
class SeedDMS_CheckSumTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
|
|
|
|
/**
|
|
* Run the task
|
|
*
|
|
* @param $task task to be executed
|
|
* @param $dms dms
|
|
* @return boolean true if task was executed succesfully, otherwise false
|
|
*/
|
|
public function execute($task) {
|
|
$dms = $this->dms;
|
|
$logger = $this->logger;
|
|
$taskparams = $task->getParameter();
|
|
$folder = $dms->getRootFolder();
|
|
|
|
$folderprocess = new SeedDMS_Task_CheckSum_Process_Folder();
|
|
$tree = new SeedDMS_FolderTree($folder, array($folderprocess, 'process'));
|
|
call_user_func(array($folderprocess, 'process'), $folder);
|
|
|
|
return true;
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Check all documents for a propper checksum';
|
|
}
|
|
|
|
public function getAdditionalParams() {
|
|
return array(
|
|
);
|
|
}
|
|
} /* }}} */
|
|
|
|
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['expireddocs'] = 'SeedDMS_ExpiredDocumentsTask';
|
|
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['indexingdocs'] = 'SeedDMS_IndexingDocumentsTask';
|
|
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['checksum'] = 'SeedDMS_CheckSumTask';
|