gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2024-11-26 15:32:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
79560a8164
seeddms-code/inc/inc.Tasks.php

1048 lines
39 KiB
PHP
Raw Blame History

<?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 SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) {
$dms = $this->dms;
$user = $this->user;
$settings = $this->settings;
$logger = $this->logger;
$taskparams = $task->getParameter();
$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 = '';
require_once('inc/inc.ClassEmailNotify.php');
$email = new SeedDMS_EmailNotify($dms, $settings->_smtpSendFrom, $settings->_smtpServer, $settings->_smtpPort, $settings->_smtpUser, $settings->_smtpPassword);
if(!empty($taskparams['peruser'])) {
$users = $dms->getAllUsers();
foreach($users as $u) {
if(!$u->isGuest() && !$u->isDisabled()) {
$docs = $dms->getDocumentsExpired(intval($taskparams['days']), $u);
if (count($docs)>0) {
$bodyhtml .= "<table>".PHP_EOL;
$bodyhtml .= sprintf($tableformatheadhtml."\n", getMLText("expires", array(), ""), "ID", getMLText("name", array(), ""));
$body .= sprintf($tableformathead."\n", getMLText("expires", 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(), '<a href="'.getBaseUrl().'/out/out.ViewDocument.php?documentid='.$doc->getId().'">'.htmlspecialchars($doc->getName()).'</a>');
}
$bodyhtml .= "</table>".PHP_EOL;
if(empty($taskparams['dryrun'])) {
$params = array();
$params['count'] = count($docs);
$params['__body__'] = $body;
$params['__body_html__'] = $bodyhtml;
$params['sitename'] = $settings->_siteName;
$email->toIndividual('', $u, 'expired_docs_mail_subject', '', $params);
$logger->log('Task \'expired_docs\': Sending reminder \'expired_docs_mail_subject\' to user \''.$u->getLogin().'\'', PEAR_LOG_INFO);
} else {
$logger->log('Task \'expired_docs\': Dry run, not sending reminder \'expired_docs_mail_subject\' to user \''.$u->getLogin().'\'', PEAR_LOG_INFO);
}
}
}
}
} elseif($taskparams['email']) {
$docs = $dms->getDocumentsExpired(intval($taskparams['days']));
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(), '<a href="'.getBaseUrl().'/out/out.ViewDocument.php?documentid='.$doc->getId().'">'.htmlspecialchars($doc->getName()).'</a>');
}
$bodyhtml .= "</table>".PHP_EOL;
if(empty($taskparams['dryrun'])) {
$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);
} else {
$logger->log('Task \'expired_docs\': Dry run, not sending reminder \'expired_docs_mail_subject\' to user \''.$taskparams['email'].'\'', PEAR_LOG_INFO);
}
}
} else {
$logger->log('Task \'expired_docs\': neither peruser nor email is set', PEAR_LOG_WARNING);
}
return true;
}
public function getDescription() {
return 'Check for expired documents and set the document status';
}
public function getAdditionalParams() {
return array(
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.',
),
array(
'name'=>'email',
'type'=>'string',
'description'=> 'If set, emails are send to this address.',
),
array(
'name'=>'peruser',
'type'=>'boolean',
'description'=> 'Send mail to each user. If set, a list of all expired documents will be send to the owner of the documents.',
),
array(
'name'=>'dryrun',
'type'=>'boolean',
'description'=> 'Do not send emails, just log.',
),
);
}
} /* }}} */
/**
* 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 $scheduler;
protected $forceupdate;
protected $fulltextservice;
protected $logger;
protected $dacount;
protected $facount;
protected $ducount;
protected $fucount;
public function __construct($scheduler, $fulltextservice, $forceupdate, $logger) { /* {{{ */
$this->scheduler = $scheduler;
$this->fulltextservice = $fulltextservice;
$this->logger = $logger;
$this->forceupdate = $forceupdate;
$this->numdocs = $this->fulltextservice->Indexer()->count();
$this->dacount = 0;
$this->facount = 0;
$this->ducount = 0;
$this->fucount = 0;
} /* }}} */
public function process($folder, $depth=0) { /* {{{ */
$lucenesearch = $this->fulltextservice->Search();
$documents = $folder->getDocuments();
$logger = $this->logger;
// echo str_repeat(' ', $depth+1).$folder->getId().":".$folder->getFolderPathPlain()." ";
if(($this->numdocs == 0) || !($hit = $lucenesearch->getFolder($folder->getId()))) {
try {
$idoc = $this->fulltextservice->IndexedDocument($folder, true);
$error = $idoc->getErrorMsg();
if(!$error) {
if(isset($GLOBALS['SEEDDMS_HOOKS']['indexFolder'])) {
foreach($GLOBALS['SEEDDMS_HOOKS']['indexFolder'] as $hookObj) {
if (method_exists($hookObj, 'preIndexFolder')) {
$hookObj->preIndexDocument(null, $folder, $idoc);
}
}
}
$this->fulltextservice->Indexer()->addDocument($idoc);
// echo "(".getMLText('index_folder_added').")".PHP_EOL;
$logger->log('Task \'indexingdocs\': folder '.$folder->getId().' added', PEAR_LOG_INFO);
$this->facount++;
} else {
// echo "(".$error.")".PHP_EOL;
$logger->log('Task \'indexingdocs\': adding folder '.$folder->getId().' failed', PEAR_LOG_ERR);
}
} catch(Exception $e) {
// echo "(Timeout)".PHP_EOL;
$logger->log('Task \'indexingdocs\': adding folder '.$folder->getId().' failed', PEAR_LOG_ERR);
}
} else {
/* Check if the attribute indexed is set or has a value older
* than the lastet content. Folders without such an attribute
* where added when a new folder was added to the dms. In such
* a case the folder content wasn't indexed.
*/
try {
$indexed = (int) $hit->getDocument()->getFieldValue('indexed');
} catch (/* Zend_Search_Lucene_ */Exception $e) {
$indexed = 0;
}
if($indexed >= $folder->getDate() && !$this->forceupdate) {
// echo "(".getMLText('index_folder_unchanged').")".PHP_EOL;
} else {
$this->fulltextservice->Indexer()->delete($hit->id);
try {
$idoc = $this->fulltextservice->IndexedDocument($folder, true);
$error = $idoc->getErrorMsg();
if(!$error) {
if(isset($GLOBALS['SEEDDMS_HOOKS']['indexDocument'])) {
foreach($GLOBALS['SEEDDMS_HOOKS']['indexDocument'] as $hookObj) {
if (method_exists($hookObj, 'preIndexDocument')) {
$hookObj->preIndexDocument(null, $folder, $idoc);
}
}
}
$this->fulltextservice->Indexer()->addDocument($idoc);
// echo "(".getMLText('index_folder_updated').")".PHP_EOL;
$logger->log('Task \'indexingdocs\': folder '.$folder->getId().' updated', PEAR_LOG_INFO);
$this->fucount++;
} else {
// echo "(".$error.")".PHP_EOL;
$logger->log('Task \'indexingdocs\': updating folder '.$folder->getId().' failed', PEAR_LOG_ERR);
}
} catch(Exception $e) {
// echo "(Timeout)".PHP_EOL;
$logger->log('Task \'indexingdocs\': updating folder '.$folder->getId().' failed. '.$e->getMessage(), PEAR_LOG_ERR);
}
}
}
if($documents) {
foreach($documents as $document) {
// echo str_repeat(' ', $depth+2).$document->getId().":".$document->getName()." ";
/* If the document wasn't indexed before then just add it */
if(($this->numdocs == 0) || !($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);
}
}
}
if($this->fulltextservice->Indexer()->addDocument($idoc)) {
// echo "(".getMLText('index_document_added').")".PHP_EOL;
$logger->log('Task \'indexingdocs\': document '.$document->getId().' added', PEAR_LOG_INFO);
} else {
$logger->log('Task \'indexingdocs\': adding document '.$document->getId().' failed', PEAR_LOG_ERR);
}
$this->dacount++;
} catch(Exception $e) {
// echo "(Timeout)".PHP_EOL;
$logger->log('Task \'indexingdocs\': adding document '.$document->getId().' failed. '.$e->getMessage(), PEAR_LOG_ERR);
}
} else {
/* Check if the attribute indexed 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 {
$indexed = (int) $hit->getDocument()->getFieldValue('indexed');
} catch (/* Zend_Search_Lucene_ */Exception $e) {
$indexed = 0;
}
$content = $document->getLatestContent();
if($content) {
if($indexed >= $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);
}
}
}
if($this->fulltextservice->Indexer()->addDocument($idoc)) {
// echo "(".getMLText('index_document_updated').")".PHP_EOL;
$logger->log('Task \'indexingdocs\': document '.$document->getId().' updated', PEAR_LOG_INFO);
} else {
$logger->log('Task \'indexingdocs\': updating document '.$document->getId().' failed', PEAR_LOG_ERR);
}
$this->ducount++;
} catch(Exception $e) {
// echo "(Timeout)".PHP_EOL;
$logger->log('Task \'indexingdocs\': updating document '.$document->getId().' failed', PEAR_LOG_ERR);
}
}
} else {
// echo "(Missing content)".PHP_EOL;
$logger->log('Task \'indexingdocs\': document '.$document->getId().' misses content', PEAR_LOG_ERR);
}
}
}
}
} /* }}} */
public function statistics() {
return array('folder'=>array('add'=>$this->facount, 'update'=>$this->fucount), 'document'=>array('add'=>$this->dacount, 'update'=>$this->ducount));
}
} /* }}} */
/**
* 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 SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $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($this, $fulltextservice, $recreate, $logger);
call_user_func(array($folderprocess, 'process'), $folder, -1);
$tree = new SeedDMS_FolderTree($folder, array($folderprocess, 'process'));
$stat = $folderprocess->statistics();
$logger->log('Task \'indexingdocs\': '.$stat['folder']['add'].' folders added, '.$stat['folder']['update'].' folders updated, '.$stat['document']['add'].' documents added, '.$stat['document']['update'].' documents updated', PEAR_LOG_INFO);
} 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 { /* {{{ */
protected $logger;
public function __construct($logger) { /* {{{ */
$this->logger = $logger;
} /* }}} */
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()) {
$this->logger->log($document->getId().':'.$version->getVersion().' wrong checksum', PEAR_LOG_WARNING);
}
} else {
$this->logger->log($document->getId().':'.$version->getVersion().' missing content', PEAR_LOG_WARNING);
}
}
}
}
} /* }}} */
} /* }}} */
/**
* 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 SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $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(
);
}
} /* }}} */
/**
* Class for processing a single folder
*
* SeedDMS_Task_Preview_Process_Folder::process() is used as a callable when
* iterating over all folders recursively.
*/
class SeedDMS_Task_Preview_Process_Folder { /* {{{ */
protected $logger;
protected $previewer;
protected $widths;
public function __construct($previewer, $widths, $logger) { /* {{{ */
$this->logger = $logger;
$this->previewer = $previewer;
$this->widths = $widths;
} /* }}} */
public function process($folder) { /* {{{ */
$dms = $folder->getDMS();
$documents = $folder->getDocuments();
if($documents) {
foreach($documents as $document) {
$versions = $document->getContent();
foreach($versions as $version) {
foreach($this->widths as $previewtype=>$width) {
if($previewtype == 'detail' || $document->isLatestContent($version->getVersion())) {
$isnew = null;
if($this->previewer->createPreview($version, $width, $isnew)) {
if($isnew){
$this->logger->log('Task \'preview\': created preview ('.$width.'px) for document '.$document->getId().':'.$version->getVersion(), PEAR_LOG_INFO);
}
}
}
}
}
$files = $document->getDocumentFiles();
foreach($files as $file) {
$this->previewer->createPreview($file, $width, $isnew);
if($isnew){
$this->logger->log('Task \'preview\': created preview ('.$width.'px) for attachment of document '.$document->getId().':'.$file->getId(), PEAR_LOG_INFO);
}
}
}
}
} /* }}} */
} /* }}} */
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage core
*/
class SeedDMS_PreviewTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
/**
* Run the task
*
* @param SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) {
$dms = $this->dms;
$logger = $this->logger;
$settings = $this->settings;
$conversionmgr = $this->conversionmgr;
$taskparams = $task->getParameter();
$folder = $dms->getRootFolder();
$previewer = new SeedDMS_Preview_Previewer($settings->_cacheDir);
$logger->log('Task \'previewer\': '.($conversionmgr ? 'has conversionmgr' : 'has not conversionmgr'), PEAR_LOG_INFO);
if($conversionmgr) {
$fromservices = $conversionmgr->getServices();
foreach($fromservices as $from=>$toservices)
foreach($toservices as $to=>$services)
foreach($services as $service)
$logger->log($from.'->'.$to.' : '.get_class($service), PEAR_LOG_DEBUG);
$previewer->setConversionMgr($conversionmgr);
} else
$previewer->setConverters(isset($settings->_converters['preview']) ? $settings->_converters['preview'] : array());
$folderprocess = new SeedDMS_Task_Preview_Process_Folder($previewer, array('list'=>$settings->_previewWidthList, 'detail'=>$settings->_previewWidthDetail), $logger);
$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 missing preview image';
}
public function getAdditionalParams() {
return array(
);
}
} /* }}} */
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage core
*/
class SeedDMS_CalendarTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
/**
* Run the task
*
* @param SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) {
$dms = $this->dms;
$user = $this->user;
$logger = $this->logger;
$settings = $this->settings;
$taskparams = $task->getParameter();
$tableformat = " %-10s %-60s";
$tableformathead = " %-10s %-60s";
$tableformathtml = "<tr><td>%s</td><td>%s</td></tr>";
$tableformatheadhtml = "<tr><th>%s</th><th>%s</th></tr>";
require_once('inc/inc.ClassEmailNotify.php');
require_once('inc/inc.ClassCalendar.php');
$email = new SeedDMS_EmailNotify($dms, $settings->_smtpSendFrom, $settings->_smtpServer, $settings->_smtpPort, $settings->_smtpUser, $settings->_smtpPassword);
$calendar = new SeedDMS_Calendar($dms->getDB(), null);
$allusers = $dms->getAllUsers();
foreach($allusers as $auser) {
if(!$auser->isAdmin() && !$auser->isGuest() && !$auser->isDisabled() && $auser->getEmail()) {
$body = ''.$auser->getLogin()." <".$auser->getEmail().">\n\n";
$bodyhtml = '<p>'.$auser->getLogin()." &lt;".$auser->getEmail()."&gt;</p>";
$calendar->setUser($auser);
if(isset($taskparams['days']))
$days = intval($taskparams['days']);
else
$days = 7;
if($days < 0) {
$end = mktime(0,0,0, date('m'), date('d'), date('Y'))-1;
$start = $end+$days*86400+1;
} elseif($days > 0) {
$start = mktime(0,0,0, date('m'), date('d'), date('Y'));
$end = $start+$days*86400-1;
} else {
$start = mktime(0,0,0, date('m'), date('d'), date('Y'));
$end = $start+86400-1;
}
$events = $calendar->getEventsInInterval($start, $end);
if($events && count($events)>0) {
$body .= getMLText('startdate', [], null, $auser->getLanguage()).': '.getLongReadableDate($start)."\n";
$body .= getMLText('enddate', [], null, $auser->getLanguage()).': '.getLongReadableDate($end)."\n\n";
$bodyhtml .= '<p>'.getMLText('startdate', [], null, $auser->getLanguage()).': '.getLongReadableDate($start)."</p>";
$bodyhtml .= '<p>'.getMLText('enddate', [], null, $auser->getLanguage()).': '.getLongReadableDate($end)."</p>";
$bodyhtml .= "<table>".PHP_EOL;
$bodyhtml .= sprintf($tableformatheadhtml."\n", getMLText("date", array(), null, $auser->getLanguage()), getMLText("name", array(), null, $auser->getLanguage()));
$body .= sprintf($tableformathead."\n", getMLText("date", array(), null, $auser->getLanguage()), getMLText("name", array(), null, $auser->getLanguage()));
$body .= "---------------------------------------------------------------------------------\n";
foreach($events as $event) {
$body .= sprintf($tableformat."\n", getReadableDate($event['start']), $event['name']);
$bodyhtml .= sprintf($tableformathtml."\n", getReadableDate($event['start']), $event['name']);
}
$bodyhtml .= "</table>".PHP_EOL;
$params = array();
$params['count'] = count($events);
$params['__body__'] = $body;
$params['__body_html__'] = $bodyhtml;
$params['sitename'] = $settings->_siteName;
$email->toIndividual('', $auser, 'calendar_events_mail_subject', '', $params);
$logger->log('Task \'calendar_events\': Sending reminder \'calender_events_mail_subject\' to user \''.$auser->getLogin().'\'', PEAR_LOG_INFO);
}
}
}
return true;
}
public function getDescription() {
return 'Check calendar for upcoming events';
}
public function getAdditionalParams() {
return array(
array(
'name'=>'days',
'type'=>'integer',
'description'=> 'Number of days to look ahead starting from today. Negative values will look into the past ending today. 0 will just check for events of the current day.',
),
);
}
} /* }}} */
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage core
*/
class SeedDMS_StatisticTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
/**
* Run the task
*
* @param SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) { /* {{{ */
$dms = $this->dms;
$user = $this->user;
$logger = $this->logger;
$settings = $this->settings;
$taskparams = $task->getParameter();
$tableformat = " %-30s %5d";
$tableformathead = " %-30s %5s";
$tableformathtml = "<tr><td>%s</td><td>%d</td></tr>";
$tableformatheadhtml = "<tr><th>%s</th><th>%s</th></tr>";
require_once('inc/inc.ClassEmailNotify.php');
$email = new SeedDMS_EmailNotify($dms, $settings->_smtpSendFrom, $settings->_smtpServer, $settings->_smtpPort, $settings->_smtpUser, $settings->_smtpPassword);
$userstotal = $dms->getStatisticalData('userstotal');
$docstotal = $dms->getStatisticalData('docstotal');
$folderstotal = $dms->getStatisticalData('folderstotal');
$docsaccumulated = $dms->getStatisticalData('docsaccumulated');
$userids = $taskparams['users'];
foreach($userids as $userid) {
if(($auser = $dms->getUser((int) $userid)) && $auser->isAdmin() && !$auser->isDisabled() && $auser->getEmail()) {
/* Create individual mails, because the users may have different
* languages.
*/
$body = ''.$auser->getLogin()." <".$auser->getEmail().">\n\n";
$bodyhtml = '<p>'.$auser->getLogin()." &lt;".$auser->getEmail()."&gt;</p>";
$bodyhtml .= "<table>".PHP_EOL;
$bodyhtml .= sprintf($tableformatheadhtml."\n", getMLText("name", array(), null, $auser->getLanguage()), getMLText("number_count", array(), ""));
$body .= sprintf($tableformathead."\n", getMLText("name", array(), ""), getMLText("number_count", array(), null, $auser->getLanguage()));
$body .= "---------------------------------------------------------------------------------\n";
$bodyhtml .= sprintf($tableformathtml."\n", getMLText("users", array(), null, $auser->getLanguage()), $userstotal);
$body .= sprintf($tableformat."\n", getMLText("users", array(), null, $auser->getLanguage()), $userstotal);
$bodyhtml .= sprintf($tableformathtml."\n", getMLText("documents", array(), null, $auser->getLanguage()), $docstotal);
$body .= sprintf($tableformat."\n", getMLText("documents", array(), null, $auser->getLanguage()), $docstotal);
$bodyhtml .= sprintf($tableformathtml."\n", getMLText("folders", array(), null, $auser->getLanguage()), $folderstotal);
$body .= sprintf($tableformat."\n", getMLText("folders", array(), null, $auser->getLanguage()), $folderstotal);
$today = date('Y-m-d');
$yesterday = date('Y-m-d', time()-86400);
if(isset($docsaccumulated[$today])) {
$docstoday = $docsaccumulated[$today];
} else {
$docstoday = 0;
}
$bodyhtml .= sprintf($tableformathtml."\n", getMLText("new_documents_today", array(), null, $auser->getLanguage()), $docstoday);
$body .= sprintf($tableformat."\n", getMLText("new_documents_today", array(), null, $auser->getLanguage()), $docstoday);
if(isset($docsaccumulated[$yesterday])) {
$docsyesterday = $docsaccumulated[$yesterday];
} else {
$docsyesterday = 0;
}
$bodyhtml .= sprintf($tableformathtml."\n", getMLText("new_documents_yesterday", array(), null, $auser->getLanguage()), $docsyesterday);
$body .= sprintf($tableformat."\n", getMLText("new_documents_yesterday", array(), null, $auser->getLanguage()), $docsyesterday);
$bodyhtml .= "</table>".PHP_EOL;
$params = array();
$params['__body__'] = $body;
$params['__body_html__'] = $bodyhtml;
$params['sitename'] = $settings->_siteName;
$email->toIndividual('', $auser, 'statistics_mail_subject', '', $params);
$logger->log('Task \'statistics\': Sending statistics \'statistics_mail_subject\' to user \''.$auser->getLogin().'\'', PEAR_LOG_INFO);
}
}
return true;
} /* }}} */
public function getDescription() { /* {{{ */
return 'Send statistics by email';
} /* }}} */
public function getAdditionalParams() { /* {{{ */
return array(
array(
'name'=>'users',
'type'=>'users',
'multiple'=>true,
'description'=> 'Send statistics report to this users',
)
);
} /* }}} */
} /* }}} */
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage core
*/
class SeedDMS_RecentChangesTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
/**
* Run the task
*
* @param SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) { /* {{{ */
$dms = $this->dms;
$user = $this->user;
$settings = $this->settings;
$logger = $this->logger;
$taskparams = $task->getParameter();
$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>";
require_once('inc/inc.ClassEmailNotify.php');
$email = new SeedDMS_EmailNotify($dms, $settings->_smtpSendFrom, $settings->_smtpServer, $settings->_smtpPort, $settings->_smtpUser, $settings->_smtpPassword);
if(!empty($taskparams['users'])) {
$userids = $taskparams['users'];
$users = [];
foreach($userids as $userid)
if($u = $dms->getUser($userid))
$users[] = $u;
} else {
$users = $dms->getAllUsers();
}
if(!empty($taskparams['lists'])) {
$lists = $taskparams['lists'];
} else {
$lists = ['newdocuments', 'updateddocuments', 'statuschange'];
}
$docs = [];
foreach($lists as $dt) {
$docs[$dt] = $dms->getLatestChanges($dt, mktime(0, 0, 0)-intval($taskparams['days'])*86400, time());
}
foreach($users as $u) {
if(!$u->isGuest() && !$u->isDisabled()) {
$body = '';
$bodyhtml = '';
foreach($lists as $dt) {
$params = array();
$bodyhtml .= "<h2>".getMLText('latest_'.$dt)."</h2>".PHP_EOL;
$body .= getMLText('latest_'.$dt).PHP_EOL.PHP_EOL;
$ds = SeedDMS_Core_DMS::filterAccess($docs[$dt], $u, M_READ);
$params['count_'.$dt] = count($ds);
if (count($ds)>0) {
$bodyhtml .= "<table>".PHP_EOL;
$bodyhtml .= sprintf($tableformatheadhtml."\n", getMLText("date", array(), ""), "ID", getMLText("name", array(), ""));
$body .= sprintf($tableformathead."\n", getMLText("date", array(), ""), "ID", getMLText("name", array(), ""));
$body .= "---------------------------------------------------------------------------------\n";
foreach($ds as $doc) {
$body .= sprintf($tableformat."\n", getReadableDate($doc->getDate()), $doc->getId(), $doc->getName());
$bodyhtml .= sprintf($tableformathtml."\n", getReadableDate($doc->getDate()), $doc->getId(), '<a href="'.getBaseUrl().'/out/out.ViewDocument.php?documentid='.$doc->getId().'">'.htmlspecialchars($doc->getName()).'</a>');
}
$bodyhtml .= "</table>".PHP_EOL;
$body .= PHP_EOL;
}
}
$params['__body__'] = $body;
$params['__body_html__'] = $bodyhtml;
$params['sitename'] = $settings->_siteName;
$email->toIndividual('', $u, 'recentchanges_mail_subject', '', $params);
$logger->log('Task \'recentchanges\': Sending reminder \'recentchanges_mail_subject\' to user \''.$u->getLogin().'\'', PEAR_LOG_INFO);
}
}
return true;
} /* }}} */
public function getDescription() { /* {{{ */
return 'Report new and updated documents and those with a changed status';
} /* }}} */
public function getAdditionalParams() { /* {{{ */
return array(
array(
'name'=>'days',
'type'=>'integer',
'description'=> 'Number of days to look back.',
),
array(
'name'=>'lists',
'type'=>'select',
'description'=>'Document lists to be included.',
'multiple'=>true,
'options'=>[['newdocuments', getMLText('latest_newdocuments')], ['updateddocuments', getMLText('latest_updateddocuments')], ['statuschange', getMLText('latest_statuschange')]],
),
array(
'name'=>'users',
'type'=>'users',
'multiple'=>true,
'description'=> 'Send list of recently changed or added documents to this users',
)
);
} /* }}} */
} /* }}} */
/**
* Class containing methods for running a scheduled task
*
* @author Uwe Steinmann <uwe@steinmann.cx>
* @package SeedDMS
* @subpackage core
*/
class SeedDMS_ImportDropFolderTask extends SeedDMS_SchedulerTaskBase { /* {{{ */
private static function getFiles($path, $recursive=false) {
if($recursive)
$rii = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
else
$rii = new DirectoryIterator($path);
$files = array();
try {
foreach ($rii as $file)
if (!$file->isDir())
$files[] = [substr($file->getPath(), strlen($path)+1), $file->getFilename()];
} catch(Exception $e) {
}
return $files;
}
/**
* Run the task
*
* @param SeedDMS_SchedulerTask $task task to be executed
* @return boolean true if task was executed succesfully, otherwise false
*/
public function execute(SeedDMS_SchedulerTask $task) { /* {{{ */
$dms = $this->dms;
$user = $this->user;
$logger = $this->logger;
$settings = $this->settings;
$fulltextservice = $this->fulltextservice;
$notifier = $this->notifier;
$taskparams = $task->getParameter();
$dropfolderdir = addDirSep($settings->_dropFolderDir);
if(!empty($taskparams['targetfolder'])) {
if(!($folder = $dms->getFolder($taskparams['targetfolder']))) {
$logger->log('Task \'import_dropfolder\': target folder with id '.$taskparams['targetfolder'].' does not exist', PEAR_LOG_ERR);
return false;
}
} else {
$logger->log('Task \'import_dropfolder\': target folder not set', PEAR_LOG_ERR);
return false;
}
if(!empty($taskparams['users'])) {
$userids = $taskparams['users'];
$users = [];
foreach($userids as $userid)
if($u = $dms->getUser($userid))
$users[] = $u;
} else {
$users = $dms->getAllUsers();
}
foreach($users as $user) {
$dir = $dropfolderdir.$user->getLogin();
$logger->log('Task \'import_dropfolder\': import from \''.$dir.'\' for user \''.$user->getLogin().'\' into \''.$folder->getName().'\'', PEAR_LOG_INFO);
/* Check if we are still looking in the configured directory and
* not somewhere else, e.g. if the login was '../test'
*/
if(dirname($dir).DIRECTORY_SEPARATOR == $dropfolderdir) {
if(is_dir($dir)) {
$files = self::getFiles($dir, !empty($taskparams['recursive']));
foreach($files as $file) {
$logger->log('Task \'import_dropfolder\': import \''.($file[0] ? $file[0].DIRECTORY_SEPARATOR : '').$file[1].'\' for user \''.$user->getLogin().'\'', PEAR_LOG_INFO);
if(empty($taskparams['dryrun'])) {
$mimetype = SeedDMS_Core_File::mimetype($dir.DIRECTORY_SEPARATOR.$file[0].$file[1]);
$lastDotIndex = strrpos($file[1], ".");
if (is_bool($lastDotIndex) && !$lastDotIndex) $filetype = ".";
else $filetype = substr($file[1], $lastDotIndex);
$expires = false;
if($settings->_presetExpirationDate) {
$expires = strtotime($settings->_presetExpirationDate);
}
$controller = Controller::factory('AddDocument', array('dms'=>$dms, 'user'=>$user));
$controller->setParam('documentsource', 'importdropfolder');
$controller->setParam('folder', $folder);
$controller->setParam('fulltextservice', $fulltextservice);
$controller->setParam('name', $file[1]);
$controller->setParam('comment', '');
$controller->setParam('expires', $expires);
$controller->setParam('keywords', '');
$controller->setParam('categories', []);
$controller->setParam('owner', $user);
$controller->setParam('userfiletmp', $dir.DIRECTORY_SEPARATOR.$file[0].$file[1]);
$controller->setParam('userfilename', $file[1]);
$controller->setParam('filetype', $filetype);
$controller->setParam('userfiletype', $mimetype);
$minmax = $folder->getDocumentsMinMax();
$deviation = rand(10, 1000)/10;
if($settings->_defaultDocPosition == 'start')
$controller->setParam('sequence', $minmax['min'] - $deviation);
else
$controller->setParam('sequence', $minmax['max'] + $deviation);
$controller->setParam('reviewers', []);
$controller->setParam('approvers', []);
$controller->setParam('reqversion', 1);
$controller->setParam('versioncomment', '');
$controller->setParam('attributes', []);
$controller->setParam('attributesversion', array());
$controller->setParam('workflow', null);
$controller->setParam('notificationgroups', array());
$controller->setParam('notificationusers', array());
$controller->setParam('initialdocumentstatus', $settings->_initialDocumentStatus);
$controller->setParam('maxsizeforfulltext', $settings->_maxSizeForFullText);
$controller->setParam('defaultaccessdocs', $settings->_defaultAccessDocs);
if(!$document = $controller()) {
$err = $controller->getErrorMsg();
if(is_string($err))
$errmsg = getMLText($err);
elseif(is_array($err)) {
$errmsg = getMLText($err[0], $err[1]);
} else {
$errmsg = $err;
}
$logger->log('Task \'import_dropfolder\': import of \''.($file[0] ? $file[0].DIRECTORY_SEPARATOR : '').$file[1].'\' for user \''.$user->getLogin().'\' failed', PEAR_LOG_ERR);
} else {
// Send notification to subscribers of folder.
if($notifier) {
$notifier->sendNewDocumentMail($document, $user);
}
/* Remove the file, unless it shall stay in the drop folder */
if(empty($taskparams['keepfile'])) {
if(file_exists($dir.DIRECTORY_SEPARATOR.$file[0].$file[1])) {
unlink($dir.DIRECTORY_SEPARATOR.$file[0].$file[1]);
}
}
}
}
}
}
}
}
return true;
} /* }}} */
public function getDescription() { /* {{{ */
return 'Import all files from drop folder';
} /* }}} */
public function getAdditionalParams() { /* {{{ */
return array(
array(
'name'=>'users',
'type'=>'users',
'multiple'=>true,
'description'=> 'Use this user for the import',
),
array(
'name'=>'recursive',
'type'=>'boolean',
'description'=> 'If set, import documents from sub folders in drop folder directory.',
),
array(
'name'=>'targetfolder',
'type'=>'folder',
'description'=> getMLText('task_core_importdropfolder_targetfolder_desc'),
),
array(
'name'=>'keepfile',
'type'=>'boolean',
'description'=> getMLText('task_core_importdropfolder_keepfile_desc'),
),
array(
'name'=>'dryrun',
'type'=>'boolean',
'description'=> getMLText('task_core_importdropfolder_dryrun_desc'),
),
);
} /* }}} */
} /* }}} */
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['expireddocs'] = 'SeedDMS_ExpiredDocumentsTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['indexingdocs'] = 'SeedDMS_IndexingDocumentsTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['checksum'] = 'SeedDMS_CheckSumTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['preview'] = 'SeedDMS_PreviewTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['calendar'] = 'SeedDMS_CalendarTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['statistic'] = 'SeedDMS_StatisticTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['importdropfolder'] = 'SeedDMS_ImportDropFolderTask';
$GLOBALS['SEEDDMS_SCHEDULER']['tasks']['core']['recentchanges'] = 'SeedDMS_RecentChangesTask';
Reference in New Issue View Git Blame Copy Permalink