XRC_class.prg

<?php

    /* Possible Return Objects
            value
            'AliasInfo'
            'EmailClientSummary'
            'WebmailPresentation'
            'Letter'
            'MailboxSummary'
            'FolderSummary'
            'ForwardingInfo'
            'AutoResponse'
            'CreateUserOptions'
            'UserAuthenticationInfo'
            'ClientPreferences'
            'WebMailPreferences'
            'MatchingAccount'
        */

// *** END OF TESTING PORTION
    /* -- CLASS FOR XRC-API 
                ** 8/15/2007 - MWS


                ** PROPERTIES
                dist_ID                     - This is the Distributor ID
                dist_PWD                    - This is the Distributor Password
                
                XRC_Server              - XRC Server part of the URL
                XRC_Script              - Script portion of the URL

                is_success              - Was an error returned from the remote call? True/False
                ** METHODS
    */

class XRC_API {
    var $dist_ID;
    var $dist_PWD;
    var $XRC_Server;
    var $XRC_Script;

    var $is_success;
    var $XRC_FullData;

    var $Resp_version;
    var $Resp_server;
    var $Resp_status;
    var $Resp_timestamp;
    var $Resp_response;
    var $Resp_Array;
    var $Resp_ReturnObjectType;
    var $Resp_ReturnObjectSize;

    var $values;

    var $ErrDesc;

    var $XRC_CMD = Array("version"=>"","clientID"=>"", "password"=>"", "cmd"=>"", "args"=>Array());

    function XRC_API_Method ($p_distID = '', $p_distPWD = '') {
    // function XRC_API($p_distID = '', $p_distPWD = '') {
        // * SET Default values
        $this->XRC_CMD["version"] = "1";    
        $this->XRC_CMD["clientID"] = ($p_distID != '' ? $p_distID : '1646757');
        $this->XRC_CMD["password"] = ($p_distPWD != '' ? $p_distPWD : 'tpw4tnms');

        $this->XRC_Server = "xrc.everyone.net";
        $this->XRC_Script = "/ccc/xrc";


        // $this->XRC_Server = "192.168.169.53";
        // $this->XRC_Script = "/~mark/test_rec.php";
    }

    function XRC_Parse () {

        // * The status should always return
        /*          
                version: x
                status: x
                server: xyz
                timestamp: ########
        */
        $pattern = "/version: ([\d]+)\nstatus: ([\d]+)\nserver: ([\w]+)\ntimestamp: ([\w]+)\n([^?]+)/";

        preg_match ($pattern, $this->XRC_FullData, $matches);
        
        /* Matches should fall into the following -- 
                1 - version
                2 - status
                3 - server
                4 - timestamp
                5 - real response
        */
        $this->Resp_version   = $matches[1];
        $this->Resp_status    = $matches[2];
        $this->Resp_server    = $matches[3];
        $this->Resp_timestamp = $matches[4];
        $this->Resp_response  = $matches[5];

        // ** SET SUCCESS --- status = 0 then true else false
        $this->is_success = ($this->Resp_status == 0 ? true : false);

        if ($this->is_success) {
            // ** PASSED **
            // Decipher the data
            $this->XRC_StripNewLine();

            // $this->Resp_Array    = explode("\n", $this->Resp_response);
            $this->Resp_Array   = explode("\n", $this->Resp_response);
            // ** REMOVE a possible empty line at the end of the array -- caused by the explode of newlines
            if ($this->Resp_Array[count($this->Resp_Array) - 1] == "") {
                array_pop ($this->Resp_Array);
            }


            // $this->XRC_Decipher($this->Resp_response);
            $this->values = $this->XRC_CreateList($this->Resp_Array);
            // $this->XRC_MassageData($this->values);
        } else {
            // ** FAILED **
            // Determine the error 
            $this->XRC_GetError();
        }
 print "<br>*** RESPONSE *** <bR>Version: {$this->Resp_version}<br>Status: {$this->Resp_status}<bR>Server: {$this->Resp_server}<br>Timestamp: {$this->Resp_timestamp}<br>Remainder: {$this->Resp_response}<br>";
    }

    function clearArgs() {
        // ** THIS SHOULD CLEAR THE ARRAY
        $this->XRC_CMD["args"] = Array();
    }

    function addArgs($type, $value) {
        // ** Based on the type -- The value will get formatted differently
        $arg_value = "";
        if ($type == "I") {
            // ** INTEGER
            $arg_value = $value . "+";
        } elseif ($type == "S") {
            $arg_value = urlencode("\"$value\"") . "+";
        }
        $this->XRC_CMD["args"][] = $arg_value;
    }

    function setCmd($value) {
        $this->clearArgs();
        $this->XRC_CMD['cmd'] = $value;
        // ** Set the return Object Type -- based on the method
        switch ($value) {
            case "listClientIDsOfDistributor":
            case "listUserNamesOfClient":
                $this->Resp_ReturnObjectType = "value";
                $this->Resp_ReturnObjectSize = "single";
                break;
            case "summarizeEmailClient":
                $this->Resp_ReturnObjectType = "EmailClientSummary";
                $this->Resp_ReturnObjectSize = "single";
                break;
            case "summarizeEmailClientsOfDistributor":
                $this->Resp_ReturnObjectType = "EmailClientSummary";
                $this->Resp_ReturnObjectSize = "list";
                break;
            case "summarizeUserMailbox":
                $this->Resp_ReturnObjectType = "MailboxSummary";
                $this->Resp_ReturnObjectSize = "single";
                break;
            default:
                $this->Resp_ReturnObjectType = "value";
                $this->Resp_ReturnObjectSize = "single";
                break;
        }
    }

    function SendRequest($useHTTPS = true) {

        $this->is_success = false;
        $this->XRC_FullData = "";
        $this->ErrDesc = "";
        $this->values = "";
        
        $url = "http" . ($useHTTPS ? "s" : "") . "://{$this->XRC_Server}{$this->XRC_Script}";

    fwrite ($fp, "<br> CMD - $cmd");
fclose($fp);

        $server_post = "";
        $server_post .= "version=" . $this->XRC_CMD['version'];
        $server_post .= "&clientID=" . $this->XRC_CMD['clientID'];
        $server_post .= "&password=" . $this->XRC_CMD['password'];
        $server_post .= "&cmd=" . $this->XRC_CMD['cmd'];
    
        $arg_string = "";   
        foreach ($this->XRC_CMD['args'] as $key => $value) {
            // $arg_string .= (strlen($arg_string) > 0 ? " " : "") . $value;
            $arg_string .= $value;
        }
        $server_post .= "&args=($arg_string)";
//      $cmd = "/usr/bin/curl --silent --data-binary '$server_post' -H 'Content-Type: application/x-eon-xrc-response' $url";

//      $cmd = "/usr/bin/curl --silent --data-binary \"`echo -e 'version: 1\nclientID: 1646757\npassword: tpw4tnms\n\nnoop()'`\" -H 'Content-Type: application/x-eon-xrc-response' $url";

//      $cmd = "https://xrc.everyone.net/ccc/xrc?version=1&clientID=1646757&password=tpw4tnms&cmd=noop&args=()";
// $cmd = "https://xrc.everyone.net/ccc/xrc?version=1&clientID=1646757&password=tpw4tnms&cmd=getClientUserCap&args=(1647402+)";
// echo  "https://xrc.everyone.net/ccc/xrc?version=1&clientID=1646757&password=tpw4tnms&cmd=getClientUserCap&args=(1647402+)";


        $cmd = $url . "?" . $server_post;
// echo "<br>$cmd";

        // $fp = fopen ("/tmp/xrc_class.txt", "w+");
// // fwrite($fp, $cmd);
// // fclose($fp);

        // Open the file handle for curl
        // $curl_ptr = popen($cmd, "r");
        $curl_ptr = fopen($cmd, "r");
        $curl_response = "";
        if ($curl_ptr)  {
            do {
                $curl_data = @fread($curl_ptr, 8192);
                if (strlen($curl_data) == 0) {
                    break;
                }
                $curl_response .= $curl_data;
            } while(true);

            // pclose($curl_ptr);
            fclose($curl_ptr);
        }


        $fp = fopen ("/home/ubuntu/mark/xrc_class.txt", "a+");
        fwrite ($fp, "Response - $curl_response");
// // fwrite($fp, $cmd);
fclose($fp);

        // fwrite($fp, $curl_response);
        // fclose($fp);

        $this->XRC_FullData = $curl_response;
        $this->XRC_Parse();
    }
    function XRC_GetError() {
        // ** This will Set the Error description
        $this->ErrDesc = $this->Resp_response;
    }
    function XRC_Decipher($pString) {
        // ** Determine the type of object and set accordingly.....hmm...

        $retValue = "";
/*
        if (substr($pString, 0, 1) == "/") {
            // ** This is a single value such as /T, /F, /NULL -- strip the /
            $retValue = substr($pString, 1);
        } elseif (substr($pString, 0, 1) == "(") {
            // ** This is a LIST -- 
            // $pattern = "/[(\n]( [\d]+ )[\n)]/";
$pattern = "/( [\"]{0,1}[\w]+[\"]{0,1} \n)/";
//          $pattern = "/[(\n]( [\d]+ )[\n)]/";
// print "<br>COUNT -- " . preg_match_all ($pattern, $pString, $matches) . "<bR>";
            $retValue = $matches[1];


// print "MATCHES --- <br><br>" . print_r(array_values($matches[1])) . "<bR>";
// print "MATCHES --- " . $matches[0];
        } else {
            // ** TREAT THE RETURN VALUE AS THE VALUE
            $retValue = $pString;
        }
$pattern = "/( [\"]{0,1}[\w]+[\"]{0,1} \n)/";
$pattern = "/([^\^]+)\n/";
// print "<br>COUNT -- " . preg_match_all ($pattern, $pString, $matches) . "<bR>";

*/

        // ** Take the string -- break it into the an array of values based on the newline--- NOTE: the initial newlines should already be removed
        $Value_List = explode ("\n", $pString);

        // ** NOW -- LOOP THROUGH THE RETURNED STRING -- Parse it into the "values" array

// print "RETURN VALUE LIST " . count($Value_List);
        return $Value_List;

// print_r(array_values($Value_List));
// exit;

        /* **** DIFFERENT OBJECT TYPES
            'value',
            'AliasInfo', 
            'EmailClientSummary', 
            'WebmailPresentation', 
            'Letter', 
            'MailboxSummary', 
            'FolderSummary', 
            'ForwardingInfo', 
            'AutoResponse', 
            'CreateUserOptions', 
            'UserAuthenticationInfo', 
            'ClientPreferences', 
            'WebMailPreferences', 
            'MatchingAccount', 
        ***  */
        /* -- Need to allow the object to be single or within an array
            '{single, list}'
        */
        switch ($this->Resp_ReturnObjectType) {
            case "value":
                // ** EACH entry is the entry in the array
                $retValue = $this->XRC_MassageData($matches[1]);
                break;
            case "EmailClientSummary":
// echo "HERE<br><br><br>" . print_r(array_values($matches[0]));exit;

            default:
                $this->is_success = false;
                $this->ErrDesc = "Unknown Object Type";
                break;
        }
        return $retValue;
    }
    
    function XRC_MassageData($pData) {

        $pattern = "/[\"\/]/";
        $replacewith = "";


        $retValue = preg_replace ($pattern, $replacewith, $pData);  
        $retValue = trim($retValue);
        // return preg_replace ($pattern, $replacewith, $pData);    
        return $retValue;
    }

    function XRC_StripNewLine() {
        // ** This will strip any newline from the beginning of the string
        $cur_pos = 0;
        while (substr($this->Resp_response, $cur_pos, 1) == "\n") {
            $cur_pos++;
        }
        // ** If the position placement is greater than 0
        if ($cur_pos > 0) {
            $this->Resp_response = substr($this->Resp_response, $cur_pos);
        }
    }


    function XRC_CreateList($pArray, $enumerate=false) {

// echo "<Br><br>INSIDE CREATELIST  - " . count($pArray) . ($enumerate ? "TRUE" : "FALSE"); 
        $retValue = Array();    
        $partialArray = Array();
        $level = 0;

        for ($idxArray = 0; $idxArray < count($pArray); $idxArray++) {
            $useKey = "";
            // $value = trim($pArray[$idxArray]);           // ** REMOVE SPACES
            $partialArray = Array();
            $value = $this->XRC_MassageData($pArray[$idxArray]); // ** Remove "/" and quotes -- trim should be moved into here
// echo "<br>Print Value -- [$value]";


            // ** IF WE ENUMERATE -- AND THIS is here -- then assume we are on the key
            if ($enumerate) {
                // print "<br>ENUMERATE --- KEY - $value";
                // ** SET THE KEY TO USE
                $useKey = $value;
                $idxArray++;
                // ** Advance the index to the next position
                // $value = trim($pArray[$idxArray]);           // ** REMOVE SPACES
                $value = $this->XRC_MassageData($pArray[$idxArray]); // ** Remove "/" and quotes -- trim should be moved into here

            }

//echo "<br><br>HERE --- [$value]";

            if (substr($value, 0, 1) == ":" || substr($value, 0, 1) == "(") {
                // ** Preceded by a ":" refers to an object -- 
                $level = 1;

                // Create an array that contains only the values for this OBJECT

                for ($partIdx = ($idxArray + 1); $partIdx < count($pArray); $partIdx++) {

                    // ** Level is now 1 --- find the ")" that is also level one
                    // ** Until that time add each value to the partialArray variable
                    // $partValue = trim($pArray[$partIdx]);            // ** REMOVE SPACES
                    $partValue = $this->XRC_MassageData($pArray[$partIdx]); // ** Remove "/" and quotes -- trim should be moved into here

                    if ($level == 1 && $partValue == ")") {
                        break;
                    } elseif (strstr($partValue, ")") !== FALSE && $level > 1) {
                        $partialArray[] = $partValue;
                        $level--;
                    } elseif ((strstr($partValue, "(") !== FALSE) && ($partIdx == $idxArray)) {
                        // ** DO NOTHING 
                    } elseif (strstr($partValue,"(") !== FALSE) {
                        $level++;
                        $partialArray[] = $partValue;
                    } else {
                        $partialArray[] = $partValue;
                    }
                    
                }
                $idxArray = $partIdx;
                // ** We now have a partial array -- Now Recursive
                // ** This is enumerated because it is a complex object

// print "Start of recursion - [$value]";
// echo "<br><Br>PARTIAL LIST --- ";
// print_r(array_values($partialArray));
// echo "<br>" . count($partialArray) . " -- END PARTIAL<br><bR>";
                if ($useKey == "") {
                    $retValue[] = $this->XRC_CreateList($partialArray, (substr($value, 0, 1) == ":" ? true : false));
                } else {
                    $retValue[$useKey] = $this->XRC_CreateList($partialArray, (substr($value, 0, 1) == ":" ? true : false));
                }

// echo "<br>AFTER --- idx = $partIdx -- value " . $pArray[$partIdx];

            } else {
                // *** For this type I want to add all the consecutive values without finding a "(" or ")" onto the list
                if ($useKey == "") {
// echo "<br>Don't SET KEY";
                    $retValue[] = $pArray[$idxArray];
                } else {
// echo "<br>SET KEY";
                    $retValue[$useKey] = $pArray[$idxArray];
                }
            }

        }
        return $retValue;
    }







/*
    function XRC_CreateList($pArray, $enumerate) {
    
        $retValue = Array();    
        $partialArray = Array();
        $level = 0;
        for ($idxArray = 0; $idxArray < count($pArray); $idxArray++) {

        // foreach ($pArray as $key=>$value) {
            $value = trim($pArray[$idxArray]);          // ** REMOVE SPACES
            $value = XRC_MassageData($value); // ** Remove "/" and quotes -- trim should be moved into here
        
            switch (substr($value, 0, 1)    

            if (substr($value, 0, 1) == ":") {
                // ** Preceded by a ":" refers to an object -- 
                $level = 1;
                $retValue[] = XRC_CreateList($

                // Create an array that contains only the values for this OBJECT

                for ($partIdx = $idxArray; $partIdx < count($pArray); $partIdx++) {
                    // ** Level is now 1 --- find the ")" that is also level one
                    // ** Until that time add each value to the partialArray variable
                    $partValue = trim($pArray[$partIdx]);           // ** REMOVE SPACES
                    $partValue = XRC_MassageData($partValue); // ** Remove "/" and quotes -- trim should be moved into here

                    if ($level == 1 && $partValue == ")") {
                        break;
                    } elseif ($partValue == ")" && $level > 1) {
                        $level--;
                    } elseif ($partValue == "(") {
                        $level++;
                    }
                    $partialArray[] = $partValue;
                    
                }
                $idxArray = $partIdx;
                // ** We now have a partial array -- Now Recursive
                // ** This is enumerated because it is a complex object
                $retValue[] = XRC_CreateList($partialArray, true) {


            } elseif (substr($value, 0, 1) == "(") {
                // ** beginning of a list
                $level = 1;
                for ($partIdx = $idxArray; $partIdx < count($pArray); $partIdx++) {
                    // ** Level is now 1 --- find the ")" that is also level one
                    // ** Until that time add each value to the partialArray variable
                    $partValue = trim($pArray[$partIdx]);           // ** REMOVE SPACES
                    $partValue = XRC_MassageData($partValue); // ** Remove "/" and quotes -- trim should be moved into here

                    if ($level == 1 && $partValue == ")") {
                        break;
                    } elseif ($partValue == ")" && $level > 1) {
                        $level--;
                    } elseif ($partValue == "(") {
                        $level++;
                    }
                    $partialArray[] = $partValue;
                    
                }
                $idxArray = $partIdx;
                // ** We now have a partial array -- Now Recursive
                // ** This is enumerated because it is a complex object
            }

        }
    }
*/
}
?>