729 lines
26 KiB
PHP
729 lines
26 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* $Id$
|
||
|
|
*
|
||
|
|
* KnowledgeTree Community Edition
|
||
|
|
* Document Management Made Simple
|
||
|
|
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
|
||
|
|
* John
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or modify it under
|
||
|
|
* the terms of the GNU General Public License version 3 as published by the
|
||
|
|
* Free Software Foundation.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||
|
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||
|
|
* details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*
|
||
|
|
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
|
||
|
|
* California 94120-7775, or email info@knowledgetree.com.
|
||
|
|
*
|
||
|
|
* The interactive user interfaces in modified source and object code versions
|
||
|
|
* of this program must display Appropriate Legal Notices, as required under
|
||
|
|
* Section 5 of the GNU General Public License version 3.
|
||
|
|
*
|
||
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
||
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by
|
||
|
|
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
|
||
|
|
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
|
||
|
|
* must display the words "Powered by KnowledgeTree" and retain the original
|
||
|
|
* copyright notice.
|
||
|
|
* Contributor( s): ______________________________________
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
require_once(KT_LIB_DIR . '/actions/actionregistry.inc.php');
|
||
|
|
require_once(KT_LIB_DIR . '/workflow/workflowutil.inc.php');
|
||
|
|
require_once(KT_LIB_DIR . '/dispatcher.inc.php');
|
||
|
|
require_once(KT_LIB_DIR . '/browse/browseutil.inc.php');
|
||
|
|
require_once(KT_LIB_DIR . '/actions/entitylist.php');
|
||
|
|
|
||
|
|
require_once(KT_LIB_DIR . '/foldermanagement/folderutil.inc.php');
|
||
|
|
require_once(KT_LIB_DIR . '/documentmanagement/documentutil.inc.php');
|
||
|
|
|
||
|
|
require_once(KT_LIB_DIR . '/widgets/forms.inc.php');
|
||
|
|
|
||
|
|
require_once(KT_LIB_DIR . "/util/sanitize.inc");
|
||
|
|
|
||
|
|
// // Jarrett Jordaan: Deal with bulk action
|
||
|
|
require_once(KT_LIB_DIR . '/subscriptions/subscriptions.inc.php');
|
||
|
|
|
||
|
|
class KTBulkAction extends KTStandardDispatcher {
|
||
|
|
var $sName;
|
||
|
|
var $sDescription;
|
||
|
|
|
||
|
|
var $_sDisablePermission;
|
||
|
|
var $bAllowInAdminMode = false;
|
||
|
|
var $sHelpPage = 'ktcore/browse.html';
|
||
|
|
|
||
|
|
var $sSection = 'view_details';
|
||
|
|
|
||
|
|
var $_bMutator = false;
|
||
|
|
var $_bMutationAllowedByAdmin = true;
|
||
|
|
|
||
|
|
var $sIconClass;
|
||
|
|
|
||
|
|
// not 'sShowPermission' - mass actions are always shown
|
||
|
|
// this is used to check against individual entities
|
||
|
|
var $_sPermission = 'ktcore.permissions.read';
|
||
|
|
|
||
|
|
// Bulk Action Notification
|
||
|
|
var $uploadedDocs;
|
||
|
|
var $uploadedFolders;
|
||
|
|
var $eventAction;
|
||
|
|
|
||
|
|
function KTBulkAction($oUser = null, $oPlugin = null) {
|
||
|
|
$this->oEntityList = null;
|
||
|
|
$this->oActiveEntityList = null;
|
||
|
|
$this->oUser =& $oUser;
|
||
|
|
$this->oPlugin =& $oPlugin;
|
||
|
|
// Bulk Action Notification
|
||
|
|
$this->uploadedDocs = array();
|
||
|
|
$this->uploadedFolders = array();
|
||
|
|
$this->eventAction = null;
|
||
|
|
$this->aBreadcrumbs = array(
|
||
|
|
array('action' => 'browse', 'name' => _kt('Browse')),
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->persistParams('fEntityListCode');
|
||
|
|
parent::KTStandardDispatcher();
|
||
|
|
}
|
||
|
|
|
||
|
|
function setEntityList(&$oEntityList) {
|
||
|
|
$this->oEntityList =& $oEntityList;
|
||
|
|
}
|
||
|
|
|
||
|
|
function setUser(&$oUser) {
|
||
|
|
$this->oUser =& $oUser;
|
||
|
|
}
|
||
|
|
|
||
|
|
function _show() {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
function getURL() {
|
||
|
|
$oKTConfig =& KTConfig::getSingleton();
|
||
|
|
$sExt = '.php';
|
||
|
|
if (KTUtil::arrayGet($_SERVER, 'kt_no_extensions')) {
|
||
|
|
$sExt = '';
|
||
|
|
}
|
||
|
|
if ($oKTConfig->get('KnowledgeTree/pathInfoSupport')) {
|
||
|
|
return sprintf('%s/action%s/%s', $GLOBALS['KTRootUrl'], $sExt, $this->sName);
|
||
|
|
} else {
|
||
|
|
return sprintf('%s/action%s?kt_path_info=%s', $GLOBALS['KTRootUrl'], $sExt, $this->sName);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
function getInfo() {
|
||
|
|
if ($this->_show() === false) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$url = $this->getURL();
|
||
|
|
|
||
|
|
$aInfo = array(
|
||
|
|
'description' => $this->sDescription,
|
||
|
|
'name' => $this->getDisplayName(),
|
||
|
|
'ns' => $this->sName,
|
||
|
|
'url' => $url,
|
||
|
|
'icon_class' => $this->sIconClass,
|
||
|
|
);
|
||
|
|
|
||
|
|
$aInfo = $this->customiseInfo($aInfo);
|
||
|
|
return $aInfo;
|
||
|
|
}
|
||
|
|
|
||
|
|
function getName() {
|
||
|
|
return sanitizeForSQLtoHTML($this->sName);
|
||
|
|
}
|
||
|
|
|
||
|
|
function getDisplayName() {
|
||
|
|
return sanitizeForSQLtoHTML($this->sDisplayName);
|
||
|
|
}
|
||
|
|
|
||
|
|
function getDescription() {
|
||
|
|
return sanitizeForSQLtoHTML($this->sDescription);
|
||
|
|
}
|
||
|
|
|
||
|
|
function customiseInfo($aInfo) {
|
||
|
|
return $aInfo;
|
||
|
|
}
|
||
|
|
|
||
|
|
// helper function
|
||
|
|
function _getNames($aIds, $sEntity) {
|
||
|
|
if(count($aIds)) {
|
||
|
|
$aNames = array();
|
||
|
|
$aFunc = array($sEntity, 'get');
|
||
|
|
|
||
|
|
foreach($aIds as $id) {
|
||
|
|
$oE =& call_user_func($aFunc, $id);
|
||
|
|
$name = array();
|
||
|
|
$name['name'] = $oE->getName();
|
||
|
|
//add shortcut notice if the entity is a shortcut
|
||
|
|
if($oE->isSymbolicLink()){
|
||
|
|
$name['notice'] = _kt("Shortcut");
|
||
|
|
}
|
||
|
|
$aNames[] = $name;
|
||
|
|
}
|
||
|
|
return $aNames;
|
||
|
|
} else {
|
||
|
|
return array();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks if there are symlinks that are linking to items in the current list
|
||
|
|
* Useful if you want to prompt the user with a confirmation because they're
|
||
|
|
* automatically deleted when their targets are deleted or archived.
|
||
|
|
*
|
||
|
|
* @return boolean
|
||
|
|
*/
|
||
|
|
function symlinksLinkingToCurrentList(){
|
||
|
|
$symlinksPresent = false;
|
||
|
|
foreach($this->oActiveEntityList->getDocumentIds() as $iDocument){
|
||
|
|
$oDocument = Document::get($iDocument);
|
||
|
|
if(count($oDocument->getSymbolicLinks()) > 0){
|
||
|
|
$symlinksPresent = true;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if($symlinksPresent == false){
|
||
|
|
foreach($this->oActiveEntityList->getFolderIds() as $iFolder){
|
||
|
|
$oStartFolder = Folder::get($iFolder);
|
||
|
|
$aRemainingFolders = array($oStartFolder->getId());
|
||
|
|
while (!empty($aRemainingFolders)) {
|
||
|
|
$iFolderId = array_pop($aRemainingFolders);
|
||
|
|
$oFolder = Folder::get($iFolderId);
|
||
|
|
|
||
|
|
if(count($oFolder->getSymbolicLinks()) > 0){
|
||
|
|
$symlinksPresent = true;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$aChildDocs = Document::getList(array('folder_id = ?',array($iFolderId)));
|
||
|
|
foreach ($aChildDocs as $oDoc) {
|
||
|
|
if(count($oDoc->getSymbolicLinks()) > 0){
|
||
|
|
$symlinksPresent = true;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$aCFIds = Folder::getList(array('parent_id = ?', array($iFolderId)), array('ids' => true));
|
||
|
|
$aRemainingFolders = kt_array_merge($aRemainingFolders, $aCFIds);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $symlinksPresent;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* checks a folderList for shortcuts and queries the repositories for all folders
|
||
|
|
* that are somehow connected to these folders.
|
||
|
|
*/
|
||
|
|
function getLinkingEntities($aFolderList){
|
||
|
|
$aSearchFolders = array();
|
||
|
|
if(!empty($aFolderList)){
|
||
|
|
foreach($aFolderList as $oFolderItem){
|
||
|
|
if(Permission::userHasFolderReadPermission($oFolderItem)){
|
||
|
|
// If it is a shortcut, we should do some more searching
|
||
|
|
if($oFolderItem->isSymbolicLink()){
|
||
|
|
$oFolderItem = $oFolderItem->getLinkedFolder();
|
||
|
|
$aSearchFolders[] = $oFolderItem->getID();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$aLinkingFolders = array();
|
||
|
|
$aSearchCompletedFolders = array();
|
||
|
|
$count = 0;
|
||
|
|
while(count($aSearchFolders)>0){
|
||
|
|
$count++;
|
||
|
|
$oFolder = Folder::get(array_pop($aSearchFolders));
|
||
|
|
$sFolderId = $oFolder->getId();
|
||
|
|
// Get all the folders within the current folder
|
||
|
|
$sWhereClause = "parent_folder_ids = '{$sFolderId}' OR
|
||
|
|
parent_folder_ids LIKE '{$sFolderId},%' OR
|
||
|
|
parent_folder_ids LIKE '%,{$sFolderId},%' OR
|
||
|
|
parent_folder_ids LIKE '%,{$sFolderId}'";
|
||
|
|
$aFolderList = $this->oFolder->getList($sWhereClause);
|
||
|
|
foreach($aFolderList as $oFolderItem){
|
||
|
|
if($oFolderItem->isSymbolicLink()){
|
||
|
|
$oFolderItem = $oFolderItem->getLinkedFolder();
|
||
|
|
}
|
||
|
|
if(Permission::userHasFolderReadPermission($oFolderItem)){
|
||
|
|
if($aSearchCompletedFolders[$oFolderItem->getID()] != true){
|
||
|
|
$aSearchFolders[] = $oFolderItem->getID();
|
||
|
|
$aSearchCompletedFolders[$oFolderItem->getID()] = true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if(!isset($aLinkingFolders[$oFolder->getId()])){
|
||
|
|
$aLinkingFolders[$oFolder->getId()] = $oFolder;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $aLinkingFolders;
|
||
|
|
}
|
||
|
|
|
||
|
|
// doesn't actually do checks, as they have to be performed per-entity
|
||
|
|
function check() {
|
||
|
|
// not necessarily coming from a folder...
|
||
|
|
$iFolderId = KTUtil::arrayGet($_REQUEST, 'fFolderId', 1);
|
||
|
|
$this->oFolder = Folder::get($iFolderId);
|
||
|
|
//$this->oFolder =& $this->oValidator->validateFolder($_REQUEST['fFolderId']);
|
||
|
|
|
||
|
|
$aOptions = array(
|
||
|
|
'final' => false,
|
||
|
|
'documentaction' => 'viewDocument',
|
||
|
|
'folderaction' => 'browse',
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->aBreadcrumbs = array(array('name'=>_kt('Bulk Actions')),
|
||
|
|
array('name'=>$this->getDisplayName()));
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// check the entire entity list. this needn't be overrided at any point
|
||
|
|
function check_entities() {
|
||
|
|
$aFailed = array('documents' => array(), 'folders' => array());
|
||
|
|
$aSucceeded = array('documents' => array(), 'folders' => array());
|
||
|
|
|
||
|
|
if(!$this->oEntityList) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach($this->oEntityList->getDocumentIds() as $iId) {
|
||
|
|
$oDocument =& Document::get($iId);
|
||
|
|
|
||
|
|
if(PEAR::isError($oDocument)) {
|
||
|
|
$aFailed['documents'][] = array($iId, _kt('No such document'));
|
||
|
|
} else {
|
||
|
|
$res = $this->check_entity($oDocument);
|
||
|
|
|
||
|
|
// all these checks allow a return from check_entity of:
|
||
|
|
// 1. a PEAR error, indicating failure, with the message in the error
|
||
|
|
// 2. false, for unknown error
|
||
|
|
// 3. true, to pass
|
||
|
|
|
||
|
|
if(PEAR::isError($res)) {
|
||
|
|
$aFailed['documents'][] = array($oDocument->getName(), $res->getMessage());
|
||
|
|
} else if($res === false) {
|
||
|
|
$aFailed['documents'][] = array($oDocument->getName(), _kt('Failed (unknown reason)'));
|
||
|
|
} else {
|
||
|
|
$aSucceeded['documents'][] = $oDocument->getId();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach($this->oEntityList->getFolderIds() as $iId) {
|
||
|
|
$oFolder =& Folder::get($iId);
|
||
|
|
|
||
|
|
if(PEAR::isError($oFolder)) {
|
||
|
|
$aFailed['folders'][] = array($iId, _kt('No such folder'));
|
||
|
|
} else {
|
||
|
|
$res = $this->check_entity($oFolder);
|
||
|
|
|
||
|
|
if(PEAR::isError($res)) {
|
||
|
|
$aFailed['folders'][] = array($oFolder->getName(), $res->getMessage());
|
||
|
|
} else if($res === false) {
|
||
|
|
$aFailed['folders'][] = array($oFolder->getName(), _kt('Failed (unknown reason)'));
|
||
|
|
} else {
|
||
|
|
$aSucceeded['folders'][] = $oFolder->getId();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->oActiveEntityList = new KTEntityList($aSucceeded['documents'], $aSucceeded['folders']);
|
||
|
|
$this->aFailed = $aFailed;
|
||
|
|
|
||
|
|
return count($aSucceeded['documents']) + count($aSucceeded['folders']);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// iterate over all entites to act on them
|
||
|
|
function perform_action_on_list() {
|
||
|
|
$this->aActionResults = array('folders'=>array(), 'documents'=>array());
|
||
|
|
foreach($this->oActiveEntityList->getDocumentIds() as $iId) {
|
||
|
|
$oDocument =& Document::get($iId);
|
||
|
|
// Store document
|
||
|
|
$this->uploadedDocs[] = $oDocument;
|
||
|
|
if(!PEAR::isError($oDocument)) {
|
||
|
|
$sName = $oDocument->getName();
|
||
|
|
} else {
|
||
|
|
$sName = _kt('Error fetching document name');
|
||
|
|
}
|
||
|
|
|
||
|
|
$res = $this->perform_action($oDocument);
|
||
|
|
|
||
|
|
//check for shortcut notice
|
||
|
|
$notice = null;
|
||
|
|
if($oDocument->isSymbolicLink()){
|
||
|
|
$notice = _kt("Shortcut");
|
||
|
|
}
|
||
|
|
|
||
|
|
if(PEAR::isError($res)) {
|
||
|
|
$this->aActionResults['documents'][] = array($sName, $res->getMessage(), $notice);
|
||
|
|
} else {
|
||
|
|
// TODO better way of getting the bulk action type
|
||
|
|
if($this->eventAction == null) {
|
||
|
|
$this->eventAction = $res;
|
||
|
|
}
|
||
|
|
$this->aActionResults['documents'][] = array($sName, _kt('Success'), $notice);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// List of ducument objects
|
||
|
|
$oFolderObjects = array();
|
||
|
|
foreach($this->oActiveEntityList->getFolderIds() as $iId) {
|
||
|
|
$oFolder =& Folder::get($iId);
|
||
|
|
// Store folder
|
||
|
|
$this->uploadedFolders[] = $oFolder;
|
||
|
|
if(!PEAR::isError($oFolder)) {
|
||
|
|
$sName = $oFolder->getName();
|
||
|
|
} else {
|
||
|
|
$sName = _kt('Error fetching folder name');
|
||
|
|
}
|
||
|
|
|
||
|
|
$res = $this->perform_action($oFolder);
|
||
|
|
|
||
|
|
//check for shortcut notice
|
||
|
|
$notice = null;
|
||
|
|
if($oFolder->isSymbolicLink()){
|
||
|
|
$notice = _kt("Shortcut");
|
||
|
|
}
|
||
|
|
|
||
|
|
if(PEAR::isError($res)) {
|
||
|
|
$this->aActionResults['folders'][] = array($sName, $res->getMessage(), $notice);
|
||
|
|
} else {
|
||
|
|
// // TODO better way of getting the bulk action type
|
||
|
|
if($this->eventAction == null) {
|
||
|
|
$this->eventAction = $res;
|
||
|
|
}
|
||
|
|
$this->aActionResults['folders'][] = array($sName, _kt('Success'), $notice);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// list persistance
|
||
|
|
// fetch existing lists
|
||
|
|
function get_lists() {
|
||
|
|
$this->oEntityList = KTEntityList::retrieveList(KTUtil::arrayGet($_REQUEST, 'fListCode', null));
|
||
|
|
$this->oActiveEntityList = KTEntityList::retrieveList(KTUtil::arrayGet($_REQUEST, 'fActiveListCode', null));
|
||
|
|
if(PEAR::isError($this->oActiveEntityList)) {
|
||
|
|
$this->oActiveEntityList = null;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// persist
|
||
|
|
function store_lists() {
|
||
|
|
$this->persistParams(array('fListCode', 'fActiveListCode', 'fFolderId', 'fReturnData', 'fReturnAction'));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the return url based on the return action and data
|
||
|
|
*/
|
||
|
|
function getReturnUrl()
|
||
|
|
{
|
||
|
|
$sReturnAction = $_REQUEST['fReturnAction'];
|
||
|
|
$sReturnData = $_REQUEST['fReturnData'];
|
||
|
|
$sAction = 'main';
|
||
|
|
$qs = '';
|
||
|
|
|
||
|
|
switch ($sReturnAction){
|
||
|
|
case 'browse':
|
||
|
|
$sReturnData = (empty($sReturnData)) ? $_REQUEST['fFolderId'] : $sReturnData;
|
||
|
|
$sTargetUrl = KTBrowseUtil::getUrlForFolder(Folder::get($sReturnData));
|
||
|
|
break;
|
||
|
|
case 'simpleSearch':
|
||
|
|
$sTargetUrl = KTBrowseUtil::getSimpleSearchBaseUrl();
|
||
|
|
$extra = 'fSearchableText='.$sReturnData;
|
||
|
|
break;
|
||
|
|
case 'booleanSearch':
|
||
|
|
$sTargetUrl = KTBrowseUtil::getBooleanSearchBaseUrl();
|
||
|
|
$sAction = 'performSearch';
|
||
|
|
$extra = 'boolean_search_id='.$sReturnData;
|
||
|
|
break;
|
||
|
|
case 'search2':
|
||
|
|
$sTargetUrl = KTBrowseUtil::getSearchResultURL();
|
||
|
|
$sAction = 'searchResults';
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
$sTargetUrl = $sReturnAction;
|
||
|
|
$sAction = '';
|
||
|
|
}
|
||
|
|
|
||
|
|
$qs = (!empty($sAction))? 'action='.$sAction : '';
|
||
|
|
$qs .= (!empty($extra))? '&'.$extra : '';
|
||
|
|
$sTargetUrl = KTUtil::addQueryString($sTargetUrl, $qs);
|
||
|
|
|
||
|
|
return $sTargetUrl;
|
||
|
|
}
|
||
|
|
|
||
|
|
// forms
|
||
|
|
// form to list the entites after checking each one
|
||
|
|
function form_listing() {
|
||
|
|
$sListCode = $this->oEntityList->getCode();
|
||
|
|
$sActiveListCode = $this->oActiveEntityList->getCode();
|
||
|
|
|
||
|
|
$sTargetUrl = $this->getReturnUrl();
|
||
|
|
|
||
|
|
$oForm = new KTForm;
|
||
|
|
$oForm->setOptions(array(
|
||
|
|
'identifier' => 'ktcore.actions.bulk.listing.form',
|
||
|
|
'submit_label' => _kt('Continue'),
|
||
|
|
'targeturl' => $this->getURL(),
|
||
|
|
'action' => 'collectinfo',
|
||
|
|
'fail_action' => 'main',
|
||
|
|
'cancel_url' => $sTargetUrl,
|
||
|
|
'noframe' => true,
|
||
|
|
'extraargs' => array('fListCode' => $sListCode,
|
||
|
|
'fActiveListCode' => $sActiveListCode,
|
||
|
|
'fFolderId' => $this->oFolder->getId(),
|
||
|
|
'fReturnAction' => KTUtil::arrayGet($_REQUEST, 'fReturnAction'),
|
||
|
|
'fReturnData' => KTUtil::arrayGet($_REQUEST, 'fReturnData'),
|
||
|
|
),
|
||
|
|
'context' => $this,
|
||
|
|
));
|
||
|
|
return $oForm;
|
||
|
|
}
|
||
|
|
|
||
|
|
// form to show on action completion, and list results
|
||
|
|
function form_complete() {
|
||
|
|
$sReturnAction = KTUtil::arrayGet($_REQUEST, 'fReturnAction');
|
||
|
|
$sReturnData = KTUtil::arrayGet($_REQUEST, 'fReturnData');
|
||
|
|
$sAction = 'main';
|
||
|
|
|
||
|
|
switch ($sReturnAction){
|
||
|
|
case 'browse':
|
||
|
|
$sReturnData = (empty($sReturnData)) ? $_REQUEST['fFolderId'] : $sReturnData;
|
||
|
|
$sTargetUrl = KTBrowseUtil::getUrlForFolder(Folder::get($sReturnData));
|
||
|
|
break;
|
||
|
|
case 'simpleSearch': // do we use this?
|
||
|
|
$sTargetUrl = KTBrowseUtil::getSimpleSearchBaseUrl();
|
||
|
|
$extraargs = array('fSearchableText'=>$sReturnData);
|
||
|
|
break;
|
||
|
|
case 'booleanSearch': // do we use this?
|
||
|
|
$sTargetUrl = KTBrowseUtil::getBooleanSearchBaseUrl();
|
||
|
|
$sAction = 'performSearch';
|
||
|
|
$extraargs = array('boolean_search_id'=>$sReturnData);
|
||
|
|
break;
|
||
|
|
case 'search2':
|
||
|
|
$sTargetUrl = KTBrowseUtil::getSearchResultURL();
|
||
|
|
$sAction = 'refresh';
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
$sTargetUrl = $sReturnAction;
|
||
|
|
$sAction = '';
|
||
|
|
}
|
||
|
|
|
||
|
|
$oForm = new KTForm;
|
||
|
|
$oForm->setOptions(array(
|
||
|
|
'identifier' => 'ktcore.actions.bulk.complete.form',
|
||
|
|
'submit_label' => _kt('Return'),
|
||
|
|
'targeturl' => $sTargetUrl,
|
||
|
|
'context' => $this,
|
||
|
|
'action' => $sAction,
|
||
|
|
'extraargs' => $extraargs,
|
||
|
|
'noframe' => true,
|
||
|
|
));
|
||
|
|
return $oForm;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// main entry point - checks the entity list and displays lists
|
||
|
|
function do_main() {
|
||
|
|
// get entities (using the checkboxes atm)
|
||
|
|
$aFolders = KTUtil::arrayGet($_REQUEST, 'selection_f' , array());
|
||
|
|
$aDocuments = KTUtil::arrayGet($_REQUEST, 'selection_d' , array());
|
||
|
|
$this->oEntityList = new KTEntityList($aDocuments, $aFolders);
|
||
|
|
|
||
|
|
// gives us $this->aFailed
|
||
|
|
$iActiveCount = $this->check_entities();
|
||
|
|
|
||
|
|
$oTemplating =& KTTemplating::getSingleton();
|
||
|
|
$oTemplate = $oTemplating->loadTemplate('ktcore/bulk_action_listing');
|
||
|
|
|
||
|
|
$this->store_lists();
|
||
|
|
|
||
|
|
return $oTemplate->render(array('context' => $this,
|
||
|
|
'form' => $this->form_listing(),
|
||
|
|
'failed' => $this->aFailed,
|
||
|
|
'active' => $this->oActiveEntityList,
|
||
|
|
'activecount' => $iActiveCount,
|
||
|
|
'failedform' => $this->form_complete(),
|
||
|
|
'folders' => $this->_getNames($this->oActiveEntityList->getFolderIds(), 'Folder'),
|
||
|
|
'documents' => $this->_getNames($this->oActiveEntityList->getDocumentIds(), 'Document')));
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
// override to add a screen to get a reason, or whatever
|
||
|
|
// remember to pass to perform action next, and call the super's method
|
||
|
|
function do_collectinfo() {
|
||
|
|
$this->store_lists();
|
||
|
|
return $this->do_performaction();
|
||
|
|
}
|
||
|
|
|
||
|
|
// perform the action itself, and list results (completion action)
|
||
|
|
function do_performaction() {
|
||
|
|
$this->get_lists();
|
||
|
|
$this->aPersistParams = array();
|
||
|
|
$targetFolderId = $_REQUEST['fFolderId'];
|
||
|
|
$targetFolder =& Folder::get($targetFolderId);
|
||
|
|
$this->perform_action_on_list();
|
||
|
|
// Parse affected documents and folders
|
||
|
|
if(count($this->uploadedDocs) > 0)
|
||
|
|
$this->do_notification($this->uploadedDocs, $this->eventAction, $targetFolder);
|
||
|
|
elseif(count($this->uploadedFolders) > 0)
|
||
|
|
$this->do_notification($this->uploadedFolders, $this->eventAction, $targetFolder);
|
||
|
|
// Action specific Emails
|
||
|
|
// Check if its a move action
|
||
|
|
if($this->eventAction == "MovedDocument") {
|
||
|
|
// Notify the folder from which the action happened
|
||
|
|
$originalFolderId = $_REQUEST['fOriginalFolderId'];
|
||
|
|
$originalFolder =& Folder::get($originalFolderId);
|
||
|
|
if(count($this->uploadedDocs) > 0)
|
||
|
|
$this->do_notification($this->uploadedDocs, $this->eventAction, $originalFolder);
|
||
|
|
elseif(count($this->uploadedFolders) > 0)
|
||
|
|
$this->do_notification($this->uploadedFolders, $this->eventAction, $originalFolder);
|
||
|
|
}
|
||
|
|
|
||
|
|
$oTemplating =& KTTemplating::getSingleton();
|
||
|
|
$oTemplate = $oTemplating->loadTemplate('ktcore/bulk_action_complete');
|
||
|
|
|
||
|
|
return $oTemplate->render(array('context' => $this,
|
||
|
|
'list' => $this->aActionResults,
|
||
|
|
'form' => $this->form_complete()));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Jarrett Jordaan: Deal with bulk actions
|
||
|
|
function do_notification($objects, $eventAction, $targetFolder) {
|
||
|
|
// Make sure there were documents/folders affected
|
||
|
|
if ($targetFolder && count($objects) > 0 && $eventAction != '') {
|
||
|
|
$oSubscriptionEvent = new SubscriptionEvent();
|
||
|
|
$oSubscriptionEvent->notifyBulkDocumentAction($objects, $eventAction, $targetFolder);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// main overrides
|
||
|
|
|
||
|
|
// override to do the actual action, on an individual entity
|
||
|
|
function perform_action($oEntity) {
|
||
|
|
return PEAR::raiseError(_kt('Action component not implemented'));
|
||
|
|
}
|
||
|
|
|
||
|
|
// check an individual entity - this should be overrided with additional
|
||
|
|
// checks required for the specific action, but should always call its
|
||
|
|
// parent implementation
|
||
|
|
function check_entity($oEntity) {
|
||
|
|
$oPermission =& KTPermission::getByName($this->_sPermission);
|
||
|
|
if(PEAR::isError($oPermission)) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
// basic document checks
|
||
|
|
|
||
|
|
// TODO: check if this is appropriate
|
||
|
|
// should probably store the 'equivalent' action (ie. document.delete)
|
||
|
|
// and check that, rather than add a new list of actions to the workflow
|
||
|
|
// section
|
||
|
|
if(is_a($oEntity, 'Document')) {
|
||
|
|
if(!KTWorkflowUtil::actionEnabledForDocument($oEntity, $this->sName)) {
|
||
|
|
return PEAR::raiseError(_kt('Action is disabled by workflow'));
|
||
|
|
}
|
||
|
|
$status = $oEntity->getStatusID();
|
||
|
|
if($status==DELETED||$status==ARCHIVED) {
|
||
|
|
return PEAR::raiseError(_kt('Document is archived or deleted'));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// admin check
|
||
|
|
if($this->bAllowInAdminMode) {
|
||
|
|
if(KTBrowseUtil::inAdminMode($this->oUser, null)) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if(!KTPermissionUtil::userHasPermissionOnItem($this->oUser, $oPermission, $oEntity)) {
|
||
|
|
return PEAR::raiseError(_kt('You do not have the required permissions'));
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
class KTBulkDocumentAction extends KTBulkAction {
|
||
|
|
function check_entity($oEntity) {
|
||
|
|
if(!is_a($oEntity, 'Document')) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return parent::check_entity($oEntity);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
class KTBulkFolderAction extends KTBulkAction {
|
||
|
|
function check_entity($oEntity) {
|
||
|
|
if(!is_a($oEntity, 'Folder')) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return parent::check_entity($oEntity);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// util class for bulk actions
|
||
|
|
|
||
|
|
class KTBulkActionUtil {
|
||
|
|
function getBulkActionInfo($slot = 'bulkaction') {
|
||
|
|
$oRegistry =& KTActionRegistry::getSingleton();
|
||
|
|
return $oRegistry->getActions($slot);
|
||
|
|
}
|
||
|
|
|
||
|
|
function getAllBulkActions($slot = 'bulkaction') {
|
||
|
|
$aObjects = array();
|
||
|
|
|
||
|
|
foreach (KTBulkActionUtil::getBulkActionInfo($slot) as $aAction) {
|
||
|
|
list($sClassName, $sPath, $sName, $sPlugin) = $aAction;
|
||
|
|
$oRegistry =& KTPluginRegistry::getSingleton();
|
||
|
|
$oPlugin =& $oRegistry->getPlugin($sPlugin);
|
||
|
|
if (!empty($sPath)) {
|
||
|
|
require_once($sPath);
|
||
|
|
}
|
||
|
|
$aObjects[] = new $sClassName(null, null, $oPlugin);
|
||
|
|
}
|
||
|
|
return $aObjects;
|
||
|
|
}
|
||
|
|
|
||
|
|
function getBulkActionsByNames($aNames, $slot = 'bulkaction', $oUser = null) {
|
||
|
|
$aObjects = array();
|
||
|
|
foreach (KTBulkActionUtil::getBulkActionInfo($slot) as $aAction) {
|
||
|
|
list($sClassName, $sPath, $sName, $sPlugin) = $aAction;
|
||
|
|
$oRegistry =& KTPluginRegistry::getSingleton();
|
||
|
|
$oPlugin =& $oRegistry->getPlugin($sPlugin);
|
||
|
|
if (!in_array($sName, $aNames)) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
if (!empty($sPath)) {
|
||
|
|
require_once($sPath);
|
||
|
|
}
|
||
|
|
$aObjects[] = new $sClassName(null, $oUser, $oPlugin);
|
||
|
|
}
|
||
|
|
return $aObjects;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|