File Source for ktwsapi.inc.php

<?
/**
*
* This is the object model for the KnowledgeTree WebService.
* @license http://www.knowledgetree.com/KPL KnowledgeTree Public License Version 1.1
* @package KTWSAPI
*/
/*
*
* 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.
*
*/
// TODO: add more validation based on information already returned. this can prevent all validation being done server side and minimise a little traffic possibly...
// TODO: caching so that requests don't have to be returned.
// TODO: possibly add a subscriber model, where updates can be propogated through to a cache/model on the client side.
require_once('ktwsapi_cfg.inc.php');
ini_set('include_path', ini_get('include_path') . PATH_SEPARATOR . KT_PEAR_DIR);
require_once('SOAP/Client.php');
define('KTWSAPI_ERR_SESSION_IN_USE','There is a session already active.');
define('KTWSAPI_ERR_SESSION_NOT_STARTED','An active session has not been started.');
class KTWSAPI_FolderItem
{
var $ktapi;
var $parent_id;
/**
* Upload a file to KT. Returns a temp filename on the server.
*
* @param string $filename
* @param string $action
* @param int $document_id
* @return string
*/
function _upload_file($filename, $action, $document_id=null)
{
if (!extension_loaded('curl'))
{
return new PEAR_Error('CURL library not included.');
}
if (!is_file($filename) || !is_readable($filename))
{
return new PEAR_Error('Could not access file to upload.');
}
if (is_null($document_id))
{
$uploadname="upload_document";
}
else
{
$uploadname="upload_$document_id";
}
$session_id = $this->ktapi->session;
$ch = curl_init();
$fp = fopen ($filename, 'r');
curl_setopt($ch, CURLOPT_URL, KTUploadURL);
curl_setopt($ch, CURLOPT_POST, 1);
$post_fields = array(
'session_id'=>$session_id,
'action'=>$action,
'document_id'=>$document_id,
$uploadname=>'@' . $filename
);
$str = serialize($post_fields);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_fields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
$response = curl_exec ($ch);
curl_close ($ch);
if ($response == '')
{
return new PEAR_Error('No response from server.');
}
$fields=explode('&',$response);
$status_code=-1;
$msg='*not set*';
$upload_status='';
foreach($fields as $field)
{
list($fieldname, $value) = explode('=', $field);
$$fieldname = $value;
}
if ($status_code == 0)
{
$upload_status= unserialize(urldecode($upload_status));
if ($upload_status[$uploadname]['size'] == filesize($filename))
{
return $upload_status[$uploadname]['tmp_name'];
}
}
return new PEAR_Error('Could not upload file.');
}
/**
* Downlaods a file from KT.
*
* @param string $url
* @param string $localpath
* @param string $filename
* @return boolean
*/
function _download_file($url, $localpath, $filename)
{
$localfilename = $localpath . '/' . $filename;
$fp = fopen($localfilename,'wb');
if ($fp == null)
{
return new PEAR_Error('Could not create local file');
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_FILE, $fp);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
$response = curl_exec($ch);
curl_close($ch);
fclose($fp);
return $response;
}
/**
* Returns a reference to the parent folder.
*
* @return KTWSAPI_Folder
*/
function &get_parent_folder()
{
$parent = &KTAPI::get_folder_by_id($this->parent_id);
return $parent;
}
}
class KTWSAPI_Folder extends KTWSAPI_FolderItem
{
var $folder_name;
var $full_path;
var $folder_id;
/**
* Constructor
*
* @param KTWSAPI $ktapi
* @param kt_folder_detail $kt_folder_detail
* @return KTWSAPI_Folder
*/
function KTWSAPI_Folder(&$ktapi, $kt_folder_detail)
{
$this->ktapi = &$ktapi;
$this->folder_id = $kt_folder_detail->id+0;
$this->folder_name = $kt_folder_detail->folder_name;
$this->parent_id = $kt_folder_detail->parent_id+0;
$this->full_path = $kt_folder_detail->full_path;
}
/**
* Returns a reference to a KTWSAPI_Folder
*
* @param KTWSAPI $ktapi
* @param int $folderid
* @return KTWSAPI_Folder
*/
function &get(&$ktapi, $folderid)
{
assert(!is_null($ktapi));
assert(is_a($ktapi, 'KTWSAPI'));
assert(is_numeric($folderid));
$folderid += 0;
$kt_folder_detail = $ktapi->soapclient->get_folder_detail($ktapi->session, $folderid);
if (SOAP_Client::isError($kt_folder_detail))
{
return $kt_folder_detail;
}
if ($kt_folder_detail->status_code != 0)
{
return new PEAR_Error($kt_folder_detail->message);
}
$folder = & new KTWSAPI_Folder($ktapi, $kt_folder_detail);
return $folder;
}
/**
* Returnss the parent folder id.
*
* @return int
*/
function get_parent_folder_id()
{
return $this->parent_id;
}
/**
* Returns the folder name.
*
* @return string
*/
function get_folder_name()
{
return $this->folder_name;
}
/**
* Returns the current folder id.
*
* @return int
*/
function get_folderid()
{
return $this->folder_id;
}
/**
* Returns the foldre based on foldername.
*
* @param string $foldername
* @return KTWSAPI_Folder
*/
function &get_folder_by_name($foldername)
{
$path = $this->full_path . '/' . $foldername;
if (substr($path,0,13) == '/Root Folder/')
{
$path = substr($path,13);
}
if (substr($path,0,12) == 'Root Folder/')
{
$path = substr($path,12);
}
$kt_folder_detail = $this->ktapi->soapclient->get_folder_detail_by_name($this->ktapi->session, $path);
if (SOAP_Client::isError($kt_folder_detail))
{
return $kt_folder_detail;
}
if ($kt_folder_detail->status_code != 0)
{
return new PEAR_Error($kt_folder_detail->message);
}
$folder= & new KTWSAPI_Folder($this->ktapi, $kt_folder_detail);
return $folder;
}
/**
* Returns the full folder path.
*
* @return string
*/
function get_full_path()
{
return $this->full_path;
}
/**
* Returns the contents of a folder.
*
* @param int $depth
* @param string $what
* @return kt_folder_items
*/
function get_listing($depth=1, $what='DF')
{
$kt_folder_contents = $this->ktapi->soapclient->get_folder_contents($this->ktapi->session, $this->folder_id, $depth+0, $what);
if (SOAP_Client::isError($kt_folder_contents))
{
return $kt_folder_contents;
}
if ($kt_folder_contents->status_code != 0)
{
return new PEAR_Error($kt_folder_contents->message);
}
return $kt_folder_contents->items;
}
/**
* Returns a document based on title.
*
* @param string $title
* @return KTWSAPI_Document
*/
function &get_document_by_name($title)
{
$path = $this->full_path . '/' . $title;
if (substr($path,0,13) == '/Root Folder/')
{
$path = substr($path,13);
}
if (substr($path,0,12) == 'Root Folder/')
{
$path = substr($path,12);
}
$kt_document_detail = $this->ktapi->soapclient->get_document_detail_by_name($this->ktapi->session, $path, 'T');
if (SOAP_Client::isError($kt_document_detail))
{
return $kt_document_detail;
}
if ($kt_document_detail->status_code != 0)
{
return new PEAR_Error($kt_document_detail->message);
}
$document = & new KTWSAPI_Document($this->ktapi, $kt_document_detail);
return $document;
}
/**
* Returns a document based on filename.
*
* @param string $filename
* @return KTWSAPI_Document
*/
function &get_document_by_filename($filename)
{
$path = $this->full_path . '/' . $filename;
if (substr($path,0,13) == '/Root Folder/')
{
$path = substr($path,13);
}
if (substr($path,0,12) == 'Root Folder/')
{
$path = substr($path,12);
}
$kt_document_detail = $this->ktapi->soapclient->get_document_detail_by_name($this->ktapi->session, $path, 'F');
if (SOAP_Client::isError($kt_document_detail))
{
return $kt_document_detail;
}
if ($kt_document_detail->status_code != 0)
{
return new PEAR_Error($kt_document_detail->message);
}
$document = & new KTWSAPI_Document($this->ktapi, $kt_document_detail);
return $document;
}
/**
* Adds a sub folder.
*
* @param string $foldername
* @return KTWSAPI_Folder
*/
function &add_folder($foldername)
{
$kt_folder_detail = $this->ktapi->soapclient->create_folder($this->ktapi->session, $this->folder_id, $foldername);
if (SOAP_Client::isError($kt_folder_detail))
{
return $kt_folder_detail;
}
if ($kt_folder_detail->status_code != 0)
{
return new PEAR_Error($kt_folder_detail->message);
}
$folder = &new KTWSAPI_Folder($this->ktapi, $kt_folder_detail);
return $folder;
}
/**
* Deletes the current folder.
*
* @param string $reason
* @return true
*/
function delete($reason)
{
// TODO: check why no transaction in folder_transactions
$kt_response = $this->ktapi->soapclient->delete_folder($this->ktapi->session, $this->folder_id, $reason);
if (SOAP_Client::isError($kt_response))
{
return $kt_response;
}
if ($kt_response->status_code != 0)
{
return new PEAR_Error($kt_response->message);
}
return true;
}
/**
* Renames the current folder.
*
* @param string $newname
* @return true
*/
function rename($newname)
{
$kt_response = $this->ktapi->soapclient->rename_folder($this->ktapi->session, $this->folder_id, $newname);
if (SOAP_Client::isError($kt_response))
{
return $kt_response;
}
if ($kt_response->status_code != 0)
{
return new PEAR_Error($kt_response->message);
}
return true;
}
/**
* Moves a folder to another location.
*
* @param KTWSAPI_Folder $ktwsapi_target_folder
* @param string $reason
* @return true
*/
function move(&$ktwsapi_target_folder, $reason='')
{
assert(!is_null($ktwsapi_target_folder));
assert(is_a($ktwsapi_target_folder,'KTWSAPI_Folder'));
$kt_response = $this->ktapi->soapclient->move_folder($this->ktapi->session, $this->folder_id,$ktwsapi_target_folder->get_folderid());
if (SOAP_Client::isError($kt_response))
{
return $kt_response;
}
if ($kt_response->status_code != 0)
{
return new PEAR_Error($kt_response->message);
}
return true;
}
/**
* Copies a folder to another location
*
* @param KTWSAPI_Folder $ktwsapi_target_folder
* @param string $reason
* @return true
*/
function copy(&$ktwsapi_target_folder, $reason='')
{
assert(!is_null($ktwsapi_target_folder));
assert(is_a($ktwsapi_target_folder,'KTWSAPI_Folder'));
$targetid=$ktwsapi_target_folder->get_folderid();
$kt_response = $this->ktapi->soapclient->copy_folder($this->ktapi->session, $this->folder_id,$targetid, $reason);
if (SOAP_Client::isError($kt_response))
{
return $kt_response;
}
if ($kt_response->status_code != 0)
{
return new PEAR_Error($kt_response->message);
}
return true;
}
/**
* Adds a document to the current folder.
*
* @param string $filename
* @param string $title
* @param string $documenttype
* @return KTWSAPI_Document
*/
function &add_document($filename, $title=null, $documenttype=null)
{
if (empty($title))
{
$title=basename($filename);
}
$basename=basename($filename);
if (empty($documenttype))
{
$documenttype='Default';
}
// First step - upload file
$tempfilename = $this->_upload_file($filename,'A');
if (PEAR::isError($tempfilename))
{
return new PEAR_Error($tempfilename->message);
}
// Second step - move file into KT
$kt_document_detail = $this->ktapi->soapclient->add_document($this->ktapi->session, $this->folder_id, $title, $basename, $documenttype, $tempfilename );
if (SOAP_Client::isError($kt_document_detail))
{
return $kt_document_detail;
}
if ($kt_document_detail->status_code != 0)
{
return new PEAR_Error($kt_document_detail->message);
}
$document = & new KTWSAPI_Document($this->ktapi, $kt_document_detail);
return $document;
}
}
class KTWSAPI_Document extends KTWSAPI_FolderItem
{
var $document_id;
var $title;
var $document_type;
var $version;

Source for file ktwsapi.inc.php