File Source for webservice.php

<?
/**
*
* This implements the KnowledgeTree Web Service in SOAP.
* @license http://www.knowledgetree.com/KPL KnowledgeTree Public License Version 1.1
* @package KTWEBSERVICE
*/
/*
*
* The contents of this file are subject to the KnowledgeTree Public
* License Version 1.1 ("License"); You may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.knowledgetree.com/KPL
*
* Software distributed under the License is distributed on an "AS IS"
* basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is: KnowledgeTree Open Source
*
* The Initial Developer of the Original Code is The Jam Warehouse Software
* (Pty) Ltd, trading as KnowledgeTree.
* Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
* (C) 2007 The Jam Warehouse Software (Pty) Ltd;
* All Rights Reserved.
*
*/
require_once('../config/dmsDefaults.php');
require_once('../ktapi/ktapi.inc.php');
require_once('SOAP/Server.php');
require_once('SOAP/Disco.php');
require_once('KTDownloadManager.inc.php');
// TODO: Test getting files/metadata based on versioning works and implementation is consistent.
// Status Codes as defined in the specification.
define('KTWS_SUCCESS', 0);
define('KTWS_ERR_INVALID_SESSION', 1);
define('KTWS_ERR_AUTHENTICATION_ERROR', 2);
define('KTWS_ERR_INSUFFICIENT_PERMISSIONS', 3);
define('KTWS_ERR_FILE_NOT_FOUND', 10);
define('KTWS_ERR_INVALID_FILENAME', 20);
define('KTWS_ERR_INVALID_DOCUMENT', 21);
define('KTWS_ERR_INVALID_FOLDER', 22);
define('KTWS_ERR_INVALID_METADATA', 23);
define('KTWS_ERR_INVALID_REASON', 24);
define('KTWS_ERR_INVALID_DEPTH', 25);
define('KTWS_ERR_PROBLEM', 98);
define('KTWS_ERR_DB_PROBLEM', 99);
class KTWebService
{
/**
* Defines functions, parameters, and return values.
*
* @var array
*/
var $__dispatch_map = array();
/**
* Defines the structures that are used by web service functions.
*
* @var array
*/
var $__typedef = array();
/**
* This is the namespace used by the web service.
*
* @var unknown_type
*/
var $namespace;
function KTWebService()
{
// Caching was giving some problems, so disable it.
$config = &KTConfig::getSingleton();
$cache_enabled = $config->get('cache/cacheEnabled');
if ($cache_enabled)
{
$config->setns('cache','cacheEnabled',false);
}
$this->namespace = 'KnowledgeTree';
$this->__typedef['kt_response'] =
array(
'status_code' => 'int',
'message' => 'string'
);
$this->__typedef['kt_folder_detail'] =
array(
'status_code'=>'int',
'message'=>'string',
'id' => 'int',
'folder_name' => 'string',
'parent_id' => 'int',
'full_path' => 'string',
);
$this->__typedef['kt_folder_item'] =
array(
'id' => 'int',
'item_type' => 'string',
'title' => 'string',
'creator' => 'string',
'checked_out_by' => 'string',
'modified_by' => 'string',
'filename' => 'string',
'size' => 'string',
'major_version' => 'string',
'minor_version' => 'string',
'storage_path' => 'string',
'mime_type' => 'string',
'mime_icon_path' => 'string',
'mime_display' => 'string',
'items' =>"{urn:$this->namespace}kt_folder_items"
);
$this->__typedef['kt_folder_items'] =
array(
array(
'item' => "{urn:$this->namespace}kt_folder_item"
)
);
$this->__typedef['kt_folder_contents'] =
array(
'status_code' => 'int',
'message' => 'string',
'folder_id' => 'int',
'folder_name' => 'string' ,
'full_path' => 'string' ,
'items' => "{urn:$this->namespace}kt_folder_items",
);
$this->__typedef['kt_document_detail'] =
array(
'status_code'=>'int',
'message'=>'string',
'title' => 'string',
'document_type' => 'string',
'version' => 'string',
'filename' => 'string',
'created_date' => 'string',
'created_by' => 'string',
'updated_date' => 'string',
'updated_by' => 'string',
'document_id' => 'int',
'folder_id' => 'int',
'workflow' => 'string',
'workflow_state' => 'string',
'checkout_by' => 'string',
'full_path' => 'string',
// 'metadata' => "{urn:$this->namespace}kt_metadata_fieldsets"
);
$this->__typedef['kt_metadata_selection_item'] =
array(
'id' => 'int',
'name' => 'string',
'value' => 'string',
'parent_id' => 'int'
);
$this->__typedef['kt_metadata_selection'] =
array(
array(
'item' => "{urn:$this->namespace}kt_metadata_selection_item"
)
);
$this->__typedef['kt_metadata_field'] =
array(
'name' => 'string',
'required' => 'boolean' ,
'value' => 'string' ,
'description' => 'string' ,
'control_type' => 'string' ,
'selection' => "{urn:$this->namespace}kt_metadata_selection" ,
);
$this->__typedef['kt_metadata_fields'] =
array(
array(
'field' => "{urn:$this->namespace}kt_metadata_field"
)
);
$this->__typedef['kt_metadata_fieldset'] =
array(
'fieldset' => 'string',
'description' => 'string',
'fields' => "{urn:$this->namespace}kt_metadata_fields" ,
);
$this->__typedef['kt_metadata_fieldsets'] =
array(
array(
'fieldset' => "{urn:$this->namespace}kt_metadata_fieldset"
)
);
$this->__typedef['kt_metadata_response'] =
array(
'status_code' => 'int',
'message' => 'string',
'metadata' => "{urn:$this->namespace}kt_metadata_fieldsets" ,
);
$this->__typedef['kt_document_transitions'] =
array(
array(
'transition' => 'string'
)
);
$this->__typedef['kt_document_transitions_response'] =
array(
'status_code'=>'int',
'message'=>'string',
'metadata' => "{urn:$this->namespace}kt_document_transitions"
);
$this->__typedef['kt_document_transaction_history_item'] =
array(
'transaction_name'=>'string',
'username'=>'string',
'version' => 'string',
'comment' => 'string',
'datetime' => 'string',
);
$this->__typedef['kt_document_transaction_history'] =
array(
array(
'history' => "{urn:$this->namespace}kt_document_transaction_history_item"
)
);
$this->__typedef['kt_document_transaction_history_response'] =
array(
'status_code'=>'int',
'message'=>'string',
'history' => "{urn:$this->namespace}kt_document_transaction_history"
);
$this->__typedef['kt_document_version_history_item'] =
array(
'user'=>'int',
'metadata_version'=>'string',
'content_version'=>'string',
);
$this->__typedef['kt_document_version_history'] =
array(
array(
'history' => "{urn:$this->namespace}kt_document_version_history_item"
)
);
$this->__typedef['kt_document_version_history_response'] =
array(
'status_code'=>'int',
'message'=>'string',
'history' => "{urn:$this->namespace}kt_document_version_history"
);
$this->__typedef['kt_document_types_array'] =
array(
array(
'document_type' => 'string'
)
);
$this->__typedef['kt_document_types_response'] =
array(
'status_code' => 'int',
'message' => 'string',
'document_types' => "{urn:$this->namespace}kt_document_types_array"
);
/* methods */
// login
$this->__dispatch_map['login'] =
array('in' => array('username' => 'string', 'password' => 'string', 'ip' => 'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// logout
$this->__dispatch_map['logout'] =
array('in' => array('session_id' => 'string' ),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// get_folder_detail
$this->__dispatch_map['get_folder_detail'] =
array('in' => array('session_id' => 'string', 'folder_id' => 'int' ),
'out' => array('return' => "{urn:$this->namespace}kt_folder_detail"),
);
// get_folder_detail_by_name
$this->__dispatch_map['get_folder_detail_by_name'] =
array('in' => array('session_id' => 'string', 'folder_name' => 'string' ),
'out' => array('return' => "{urn:$this->namespace}kt_folder_detail"),
);
// get_folder_contents
$this->__dispatch_map['get_folder_contents'] =
array('in' => array('session_id'=>'string','folder_id'=>'int','depth'=>'int','what'=>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_folder_contents"),
);
// create_folder
$this->__dispatch_map['create_folder'] =
array('in' => array('session_id'=>'string','folder_id'=>'int','folder_name' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_folder_detail"),
);
// delete_folder
$this->__dispatch_map['delete_folder'] =
array('in' => array('session_id'=>'string','folder_id'=>'int','reason' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// rename_folder
$this->__dispatch_map['rename_folder'] =
array('in' => array('session_id'=>'string','folder_id'=>'int','newname' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response"),
);
// copy_folder
$this->__dispatch_map['copy_folder'] =
array('in' => array('session_id'=>'string','source_id'=>'int','target_id'=>'int','reason' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// move_folder
$this->__dispatch_map['move_folder'] =
array('in' => array('session_id'=>'string','source_id'=>'int','target_id'=>'int','reason' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// get_document_detail
$this->__dispatch_map['get_document_detail'] =
array('in' => array('session_id' => 'string', 'document_id' => 'int' ),
'out' => array('return' => "{urn:$this->namespace}kt_document_detail"),
);
// checkin_document
$this->__dispatch_map['checkin_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int','filename'=>'string','reason' =>'string','tempfilename' =>'string', 'major_update'=>'boolean' ),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// add_document
$this->__dispatch_map['add_document'] =
array('in' => array('session_id'=>'string','folder_id'=>'int','title'=>'string','filename'=>'string','documentype' =>'string','tempfilename' =>'string' ),
'out' => array( 'return' => "{urn:$this->namespace}kt_document_detail" ),
);
// get_document_detail_by_name
$this->__dispatch_map['get_document_detail_by_name'] =
array('in' => array('session_id' => 'string', 'document_name' => 'string', 'what'=>'string' ),
'out' => array('return' => "{urn:$this->namespace}kt_document_detail"),
);
// checkout_document
$this->__dispatch_map['checkout_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int','reason' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// undo_document_checkout
$this->__dispatch_map['undo_document_checkout'] =
array('in' => array('session_id'=>'string','document_id'=>'int','reason' =>'string'),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// download_document
$this->__dispatch_map['download_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int' ),
'out' => array('return' => "{urn:$this->namespace}kt_response" ),
);
// delete_document
$this->__dispatch_map['delete_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int','reason'=>'string'),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// change_document_owner
$this->__dispatch_map['change_document_owner'] =
array('in' => array('session_id'=>'string','document_id'=>'int','username'=>'string','reason'=>'string'),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// copy_document
$this->__dispatch_map['copy_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int','folder_id'=>'int','reason'=>'string','newtitle'=>'string','newfilename'=>'string'),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// move_document
$this->__dispatch_map['move_document'] =
array('in' => array('session_id'=>'string','document_id'=>'int','folder_id'=>'int','reason'=>'string','newtitle'=>'string','newfilename'=>'string'),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// rename_document_title
$this->__dispatch_map['rename_document_title'] =
array('in' => array('session_id'=>'string','document_id'=>'int', 'newtitle'=>'string' ),
'out' => array( 'return' => "{urn:$this->namespace}kt_response" ),
);
// rename_document_filename
$this->__dispatch_map['rename_document_filename'] =
array('in' => array('session_id'=>'string','document_id'=>'int', 'newfilename'=>'string' ),
'out' => array( 'return' => "{urn:$this-><

Source for file webservice.php