Source for file KTDownloadManager.inc.php

Documentation is available at KTDownloadManager.inc.php

  1. <?
  2.  
  3. /**
  4.  *
  5.  * KTDownloadManager manages files in the download_files table.
  6.  * @license http://www.knowledgetree.com/KPL KnowledgeTree Public License Version 1.1
  7.  * @package KTWEBSERVICE
  8.  */
  9.  
  10. /*
  11.  *
  12.  * The contents of this file are subject to the KnowledgeTree Public
  13.  * License Version 1.1 ("License"); You may not use this file except in
  14.  * compliance with the License. You may obtain a copy of the License at
  15.  * http://www.knowledgetree.com/KPL
  16.  * 
  17.  * Software distributed under the License is distributed on an "AS IS"
  18.  * basis,
  19.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  20.  * for the specific language governing rights and limitations under the
  21.  * License.
  22.  * 
  23.  * The Original Code is: KnowledgeTree Open Source
  24.  * 
  25.  * The Initial Developer of the Original Code is The Jam Warehouse Software
  26.  * (Pty) Ltd, trading as KnowledgeTree.
  27.  * Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
  28.  * (C) 2007 The Jam Warehouse Software (Pty) Ltd;
  29.  * All Rights Reserved.
  30.  *
  31.  */
  32.  
  33. class KTDownloadManager
  34. {
  35.     var $session;     
  36.     var $age;
  37.     var $download_url;
  38.     var $random;
  39.     
  40.     /**
  41.      * Constructor for the download manager.
  42.      *
  43.      * @param KTAPI_Session $session 
  44.      * @return KTDownloadManager 
  45.      */
  46.     function KTDownloadManager()
  47.     {        
  48.         $config = &KTConfig::getSingleton();         
  49.         
  50.         $this->age = $config->get('webservice/downloadExpiry',5);
  51.         $this->download_url = $config->get('webservice/downloadUrl');
  52.         $this->random=$config->get('webservice/randomKeyText','jhsdf8q1jkjpoiudfs7sd3ds1');
  53.     }
  54.  
  55.     /**
  56.      * Sets the current session.
  57.      *
  58.      * @param string $session 
  59.      */
  60.     function set_session($session)
  61.     {
  62.         $this->session = $session;        
  63.     }    
  64.     
  65.     /**
  66.      * This returns
  67.      *
  68.      * @access public
  69.      * @param KTAPI_Document $document 
  70.      * @return string 
  71.      */
  72.     function allow_download($document, $content_version=null)
  73.     {
  74.         assert(!is_null($document));
  75.         assert(is_a($document, 'KTAPI_Document'));
  76.         
  77.         $hash = sha1("$document->documentid $this->session $this->random");
  78.         
  79.         
  80.         $id = DBUtil::autoInsert('download_files',
  81.             array(
  82.                 'document_id'=>$document->documentid,
  83.                 'session'=>$this->session,
  84.                 'download_date'=>date('Y-m-d H:i:s'),
  85.                 'hash'=>$hash        
  86.                 ),
  87.                 array('noid'=>true)
  88.             );
  89.             
  90.         return $this->build_url($hash, $document->documentid );
  91.     }
  92.     
  93.     /**
  94.      * This returns the url used to download a document.
  95.      *
  96.      * @param string $hash 
  97.      * @param int $documentid 
  98.      * @param int $userid 
  99.      * @return string 
  100.      */    
  101.     function build_url($hash, $documentid )
  102.     {
  103.         return $this->download_url . "?code=$hash&d=$documentid&u=$this->session";
  104.     }
  105.     
  106.     
  107.     /**
  108.      * This starts a download.
  109.      *
  110.      * @access public
  111.      */
  112.     function download($document_id, $hash, $version = null)
  113.     {
  114.         $sql = "SELECT 1 FROM download_files WHERE hash='$hash' AND session='$this->session' AND document_id=$document_id";
  115.         $rows = DBUtil::getResultArray($sql);
  116.         if (PEAR::isError($rows))
  117.         {
  118.             return $rows;
  119.         }
  120.         
  121.         if (count($rows) == 0)
  122.         {
  123.             return new PEAR_Error('Invalid session.');
  124.         }
  125.         
  126.         $storage =& KTStorageManagerUtil::getSingleton();
  127.         
  128.         
  129.         $ktapi = &new KTAPI();
  130.         $res = $ktapi->get_active_session($this->session);
  131.         if (PEAR::isError($res))
  132.         {
  133.             return $res;
  134.         }
  135.         
  136.         $document = $ktapi->get_document_by_id($document_id);
  137.         if (PEAR::isError($document))
  138.         {
  139.             return $document;
  140.         }
  141.         
  142.         if (!empty($version)) 
  143.         {
  144.             $version = KTDocumentContentVersion::get($version);
  145.             
  146.             $res = $storage->downloadVersion($document->document, $version);
  147.         } 
  148.         else 
  149.         {
  150.             $res = $storage->download($document->document);
  151.         }
  152.         if (PEAR::isError($res))
  153.         {
  154.             return $res;
  155.         }
  156.         
  157.         $sql = "DELETE FROM download_files WHERE hash='$hash' AND session='$this->session' AND document_id=$document_id";
  158.         $result = DBUtil::runQuery($sql);
  159.         
  160.         return true;        
  161.     }
  162.     
  163.     /**
  164.      * This will remove any temporary files that have not been dealt with in the correct timeframe.
  165.      * 
  166.      * @access public
  167.      */
  168.     function cleanup()
  169.     {
  170.         list($year,$mon,$day,$hour, $min) = explode(':', date('Y:m:d:H:i'));
  171.         $expirydate = date('Y-m-d H:i:s', mktime($hour, $min - $this->age, 0, $mon, $day, $year));
  172.         $sql = "DELETE FROM download_files WHERE download_date<'$expirydate'";    
  173.         DBUtil::runQuery($sql);    
  174.     }    
  175. }
  176. ?>

Documentation generated on Sun, 22 Apr 2007 02:30:54 +0200 by phpDocumentor 1.3.2