sharepoint_saved_search.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';
require_once SQ_CORE_PACKAGE_PATH.'/data_source/data_source/data_source.inc';
require_once SQ_LIB_PATH.'/html_form/html_form.inc';
require_once SQ_PACKAGES_PATH.'/sharepoint/lib/sharepoint_common.inc';

class Sharepoint_Saved_Search extends Data_Source
{


    function __construct($assetid=0)
    {
        parent::__construct($assetid);

        $this->_ser_attrs = TRUE;
        $this->search_clauses = NULL;

    }//end constructor


    protected function _createAdditional(Array &$link, $args=Array())
    {
        if (!parent::_createAdditional($link)) return FALSE;
        $this->setAttrValue('shadow_name', '%ds__ows_FileLeafRef%');

        return TRUE;

    }//end _createAdditional()


    public function _getAllowedLinks()
    {
        // any link is allowed
        $allowed_link['asset']['card'] = 'M';
        $allowed_link['asset']['exclusive'] = FALSE;

        $links[SQ_LINK_TYPE_1] = $allowed_link;
        $links[SQ_LINK_TYPE_2] = $allowed_link;
        $links[SQ_LINK_TYPE_3] = $allowed_link;
        $links[SQ_LINK_NOTICE] = $allowed_link;

        return $links;

    }//end _getAllowedLinks()


    public function &getResultSet()
    {
        $hash   = $this->getHashKey();

        $data_list  = $this->attr('data_list');
        if (!empty($data_list) && $data_list != 'None') {
            $result = $this->getCachedResults($hash);
            if (empty($result)) {
                try {
                    $connection = $this->getConnection();

                    $all_lists      = Array();
                    $lists_fields   = Array();
                    $list_names     = Array();

                    $valid = Sharepoint_Common::test_sharepoint_connection($connection);
                    //$connection['url']    = Sharepoint_Common::getWSDLLocation('lists', $connection['url']);
                    if ($valid) {
                        $all_lists  = Sharepoint_Common::getListCollections($connection);
                        $sp_lists   = Sharepoint_Common::getListNames($connection, $all_lists);
                        $list_names += $sp_lists;
                    }//end if

                    $search_crits   = $this->attr('search_options');
                    $search_logic   = $this->attr('search_logic');
                    $row_limit      = $this->attr('row_limit');
                    $search_crit    = isset($search_crits[$data_list]) ? $search_crits[$data_list] : Array();
                    $download_file  = $this->attr('download_file');
                    $bridge_info    = $download_file ? Array('data_path' => $this->data_path, 'url' => $this->getURL()) : Array();

                    $result = Sharepoint_Common::getListItems($connection, $data_list, $search_crit, $search_logic, $row_limit, $download_file, $bridge_info);
                    if (!empty($result)) sort($result);
                    $this->cacheResult($result, $hash);

                } catch (SoapFault $sf) {
                    $detail = '';
                    if (isset($sf->detail)) $detail = $sf->detail;
                    trigger_error($sf->getMessage().'.'.$detail, E_USER_WARNING);
                }//end try catch
            }//end else
        }//end if

        return $result;

    }//end getResultSet()


    public function getCachedResults($hash_key)
    {
        $result = $this->attr('cached_result');
        if (isset($result[$hash_key])) {
            return $result[$hash_key];
        }//end if

        return Array();

    }//end cacheResult()


    public function cacheResult($result, $hash_key)
    {
        $cached_result = $this->attr('cached_result');
        $cached_result[$hash_key]   = $result;
        $GLOBALS['SQ_SYSTEM']->am->acquireLock($this->id, 'attributes');
        if ($this->setAttrValue('cached_result', $cached_result) && $this->saveAttributes()) {
            return TRUE;
        }//end if
        $GLOBALS['SQ_SYSTEM']->am->releaseLock($this->id, 'attributes');

        return FALSE;

    }//end cacheResult()


    public function updateCachedResult($forced=FALSE)
    {
        $hash   = $this->getHashKey();

        $result = $this->attr('cached_result');
        if (isset($result[$hash])) {
            unset($result[$hash]);
        }//end if
        $this->setAttrValue('cached_result', $result);
        $new_result = $this->getResultSet();
        if (!empty($new_result)) {
            return TRUE;
        } else {
            return FALSE;
        }//end else

    }//end updateCachedResult()


    function getHashKey() {

        // Hash Key was used before when this asset uses the Cache Manager to manage its cache
        // Since attribute is used now, it's hard to go back and clear the cache for different configuration
        // so lets just use one cache set instead of multiple sets like before
        /*
        $hash = md5($unhashed_key);*/
        $hash = md5('resultSet');

        return $hash;

    }//end getHashKey()


    function getConnection()
    {
        $connector_link                 = $GLOBALS['SQ_SYSTEM']->am->getLink($this->id, SQ_LINK_NOTICE, 'sharepoint_connector', FALSE, 'sharepoint_connector');
        if (!empty($connector_link)) {
            $connector                  = $GLOBALS['SQ_SYSTEM']->am->getAsset($connector_link['minorid']);
        } else {
            $connector                  = $this;
        }//end else

        $connection                     = Array();
        $connection['url']              = $connector->attr('url');
        $connection['authentication']   = Array (
                                            'login'     => $connector->attr('username'),
                                            'password'  => $connector->attr('password'),
                                            'trace'     => '1',
                                            'exception' => '1',
                                          );

        return $connection;

    }//end getConnection()


    public function getDynamicVariableValue($variable_name)
    {
        $dynamic_vars = $this->attr('dynamic_vars');
        if (!isset($dynamic_vars[$variable_name])) return '';

        $parameter_map = $this->getAttribute('parameter_map');
        $value = $parameter_map->getParameterValue($variable_name);

        if (empty($value)) {
            $value = array_get_index($dynamic_vars, $variable_name, '');
        }//end if

        return $value;

    }//end getDynamicVariableValue()


    public function printFrontend()
    {   
        // We are only doing synching in this asset, there's no need to check for update
        if (isset($_GET['synch_now']) && !empty($_GET['synch_now'])) {
            if ($this->adminAccess()) {
                if ($this->updateCachedResult()) {
                    echo '1';
                } else {
                    echo '0';
                }//end if
            }//end if
        }//end else if
        
        // Get the sharepoint document from local server
        if (isset($_GET['file_uri']) && !empty($_GET['file_uri'])) {
            if (!$this->getAttachment($_GET['file_uri'])) {
                trigger_error('Cannot find the given file '.$_GET['file_uri'], E_USER_WARNING);
            }
        }

    }//end printFrontend()


    public function setAttrValue($name, $value)
    {
        if ($name == 'data_list' || $name == 'row_limit' || $name == 'search_logic' || $name == 'download_file') {
            $res_val    = parent::setAttrValue($name, $value);
            $this->updateCachedResult(TRUE);
            return $res_val;
        } else {
            return parent::setAttrValue($name, $value);
        }//end if
    }//end setAttrValue()


    public function getAsset($assetid, $type_code='', $mute_errors=FALSE)
    {
        $asset  = parent::getAsset($assetid, $type_code='', $mute_errors=FALSE);
        if (isset($_REQUEST['a']) && isset($_REQUEST['a']) == $assetid) {
            // Now we are looking for shadow assets to download
            if (!is_null($asset)) {
                if (isset($asset->vars['Uri']) && !empty($asset->vars['Uri'])) {
                    if ($this->getAttachedFile(($asset->vars['Uri']))) {
                        exit();
                    }
                }//end if
            }//end if
        }//end if

        return $asset;
    }//end getAsset()


    public function getAttachment($uri)
    {
        require_once SQ_FUDGE_PATH.'/standards_lists/mime_types.inc';

        $GLOBALS['SQ_SYSTEM']->setGlobalDefine('SQ_REPLACE_MYSOURCE_LEVEL_KEYWORDS', FALSE);
        
        $file_path = $this->data_path.'/'.$uri;
        if (!file_exists($file_path)) {
            return FALSE;
        }//end else
        
        $file_info = pathinfo($file_path);
        if (empty($file_info)) {
            return FALSE;
        }//end if

        $ext = strtolower($file_info['extension']);
        $type = (empty($standards_lists_mime_types[$ext])) ? 'text/plain' : $standards_lists_mime_types[$ext];

        // Fix for IE caching
        header("Pragma: public");
        header("Expires: 0");
        header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
        header("Cache-Control: private",false);

        // We'll be outputting a file
        header('Content-Type: '.$type);

        // Set the name of the file
        header('Content-Disposition: attachment; filename="'.$file_info['basename'].'";');
        header('Content-Length: '.filesize($file_path));

        // Get the source file
        readfile($file_path);

        return TRUE;
        @ob_flush();

    }//end getAttachment()



}//end class
?>