create_emailreport.prg

#!/usr/local/bin/php
<?php 
    // ** REQUIRED FILES
    require("XRC_class.prg");

    // ** 
    $xrc_logfile = "/tmp/xrc_everyone.log";
    $xrc_directory = "/home/httpd/hcupriv/";
    $xrc_prefix = "emailrpt";

    $xrc_filename = $xrc_prefix . date("Ym");

    // ** Put the argument list in the cl_args Array
    $cl_args = arguments($argv);

    // ** this will limit the number of clients to retrieve -- used for debugging
    // ** ie --limit=3
    $limit = 0;
    if (isset($cl_args['limit'])) {
        $limit = intval($cl_args['limit']);
    }

    // ** Always include zero values -- the report will choose to print them or not
    $ALL = true;
/*
    if (isset($cl_args['ALL'])) {
        $ALL = true;
    }
*/

    // ** When this is set it will write the send request information to the log
    // ** ie -debug
    $debug = false;
    if (isset($cl_args['debug'])) {
        $debug = true;
    }

    /* *** 
        Originally this form was to be run from the web browser.. 
        However, do to the length of time it can take to run, I am changing it
        to be a command line program run from a crontab entry at the last day of the
        month

        crontab entry -- executed on mork for reporting needs
        // *  This program will need 10 minutes to run...
        // ** Run early on the first day of the month
        /usr/local/bin???/create_emailreport.prg
        0 0 1 * * /usr/local/bin???/create_emailreport.prg
    */
    set_time_limit(0);


    $start_time = date("m/d/Y h:i:s");

    $xrc_fh = @fopen($xrc_logfile, "w");
    $rpt_fh = @fopen($xrc_directory . $xrc_filename, "w");
    if (!$xrc_fh) {
        exit;
    }
    // ** Write the Starting time to the logfile
    fwrite ($xrc_fh, "** START LOG FILE -- $start_time  **\n");

    if (!$rpt_fh) {
        fwrite ($xrc_fh, "Unable to open output file for reporting domain email");
        end_xrc();
        exit;
    }

    // ** Remove any files older than 15 months
    // --- Create a date that is 15months old
    $RemoveLogDate = date("Ym", mktime(0, 0, 0, date("m") - 15, date("d"), date("Y")));
    if (is_dir($xrc_directory)) {
        if ($dir_hndl = opendir($xrc_directory)) {
            while (($file = readdir($dir_hndl)) !== false) {
                if (filetype($xrc_directory . $file) == "file" && (substr($file, 0, strlen($xrc_prefix)) == $xrc_prefix)) {
                    if (substr($file, strlen($xrc_prefix)) <= $RemoveLogDate) {
                        // ** Delete File
                        unlink($xrc_directory . $file);
                    }
                }
            }
            closedir($dir_hndl);
        }
    }
    // $>setReturnObject('{value, 'AliasInfo', 'EmailClientSummary', 'WebmailPresentation', 'Letter', 'MailboxSummary', 'FolderSummary', 'ForwardingInfo', 'AutoResponse', 'CreateUserOptions', 'UserAuthenticationInfo', 'ClientPreferences', 'WebMailPreferences', 'MatchingAccount'}, '{single, list}');


    $report_XRC = new XRC_API();
    $client_XRC = new XRC_API();
    $acct_XRC = new XRC_API();

    // ** Get the client information --
    if ($debug) fwrite ($xrc_fh, "Command - summarizeEmailClientsOfDistributor");
    $report_XRC->setCmd('summarizeEmailClientsOfDistributor');
    $report_XRC->SendRequest(true);
    if ($debug) fwrite ($xrc_fh, " -- Completed\n");

    $DefaultDomainOfferID = 0;
    if (is_array($report_XRC->values[0])) {
        foreach ($report_XRC->values[0] as $key=>$value) {

            // ** RETRIEVE THE default offerID for this domain.. Pickup what's in the first position
            $DefaultDomainOfferID = $value['offerIDs'][0];

            $client_count = 0;
            $mailsize_100 = 0;
            $mailsize_250 = 0;
            $mailsize_1000 = 0;
            $mailsize_2000 = 0;
            $mailsize_100_3yrArchive = 0;
            $mailsize_100_5yrArchive = 0;
            $mailsize_100_7yrArchive = 0;

            // ** Creates an array of objects
            // ** The following can be uncommented for debugging -- this will allow you to limit the number 

            if (($loop_cntr >= $limit) && $limit > 0) {
                break;
            } else {
                $loop_cntr++;
            }

            $client_XRC->setCmd('listUserNamesOfClient');
            $client_XRC->addArgs("I", trim($value['clientID']));
            if ($debug) fwrite ($xrc_fh, "Command - listUserNamesOfClient:" . trim($value['clientID']));
            $client_XRC->SendRequest(true);
            if ($debug) fwrite ($xrc_fh, " -- Completed\n");

            if ($client_XRC->is_success) {
                
                // ** Lookup the client mailbox size for each account...
                foreach ($client_XRC->values[0] as $client_key=>$client_value) {

                    $acct_XRC->setCmd('getUserOffers');
                    $acct_XRC->addArgs("I", trim($value['clientID']));
                    $acct_XRC->addArgs("S", trim($client_value));

                    // *** SEND REQUEST
                    $acct_XRC->SendRequest(true);

                    $CurrentUserOfferID = $acct_XRC->values[0][0];


                    $OfferIDtoUse = ($CurrentUserOfferID > 0 ? $CurrentUserOfferID : $DefaultDomainOfferID);
// print "\n " . $value['clientID'] . " :: " . $DefaultDomainOfferID . " :: " . $CurrentUserOfferID . " :: " . $OfferIDtoUse . "\n";
                    switch ($OfferIDtoUse) {
                        case "6032":
                        case "6033":
                            $mailsize_100++;
                            break;
                        case "6034":
                        case "6035":
                            $mailsize_250++;
                            break;
                        case "6036":
                        case "6037":
                            $mailsize_1000++;
                            break;
                        case "6038":
                        case "6039":
                            $mailsize_2000++;
                            break;
                        case "12152":
                        case "12153":
                            $mailsize_100_3yrArchive++;
                            break;
                        case "12154":
                        case "12155":
                            $mailsize_100_5yrArchive++;
                            break;
                        case "12156":
                        case "12157":
                            $mailsize_100_7yrArchive++;
                            break;
                    }
                }

                $client_count = count($client_XRC->values[0]);
            }
// print "\nToTALS: 100::$mailsize_100 250::$mailsize_250 1000::$mailsize_1000 2000::$mailsize_2000 1003yr::$mailsize_100_3yrArchive 1005yr::$mailsize_100_5yrArchive 1007yr::$mailsize_100_7yrArchive ";
            $domain_results[] = array($value['primaryEmailDomain'], $client_count, $mailsize_100, $mailsize_250, $mailsize_1000, $mailsize_2000, $mailsize_100_3yrArchive, $mailsize_100_5yrArchive, $mailsize_100_7yrArchive);
        }
        sort($domain_results);
    }
    foreach ($domain_results as $dom_key=>$dom_value) {
        $dom_accts = 0;
        $dom_accts_prem = 0;
        $dom_credit = 10;
        $dom_total_bill = 0;
        $tr_class = ($tr_class == "odd_small" ? "even_small" : "odd_small");
        // ** Add up the items in each bucket
        $dom_accts = intval($dom_value[2]) + intval($dom_value[3]) + intval($dom_value[4]) + intval($dom_value[5]) + intval($dom_value[6]) + intval($dom_value[7]) + intval($dom_value[8]);
        // ** Add up the premium account types 
        $dom_accts_prem = (intval($dom_value[3]) * 1) + (intval($dom_value[4]) * 2) + (intval($dom_value[5]) * 3) + (intval($dom_value[6]) * 3) + (intval($dom_value[7]) * 4) + (intval($dom_value[8]) * 5);
        $dom_total_bill = ($dom_accts - $dom_credit);
        // ** Premium is ALWAYS ADDED TO THE PRICE -- Credit does not affect the premium
        $dom_total_bill = ($dom_total_bill <= 0 ? 0 : $dom_total_bill) + $dom_accts_prem;

// ** ONLY PRINT FOR NON-ZERO BILLS
        if ($dom_total_bill > 0 || $ALL) {
            fwrite ($rpt_fh, "{$dom_value[0]}\t{$dom_value[1]}\t{$dom_value[2]}\t{$dom_value[3]}\t{$dom_value[4]}\t{$dom_value[5]}\t{$dom_value[6]}\t{$dom_value[7]}\t{$dom_value[8]}\t{$dom_accts}\t{$dom_credit}\t{$dom_accts_prem}\t{$dom_total_bill}\t\n");
        }
    }

    end_xrc();

function end_xrc () {
    global $xrc_fh, $rpt_fh;

    $end_time = date("m/d/Y h:i:s");
    
    if ($xrc_fh) {
        fwrite ($xrc_fh, "\n** END LOG FILE -- $end_time **\n");
        fclose($xrc_fh);
    }
    if ($rpt_fh) {
        fclose($rpt_fh);
    }
}
function arguments($argv) {
    $_ARG = array();
    foreach ($argv as $arg) {
        if (preg_match('/--[a-zA-Z0-9]*=.*/',$arg)) {
            $str = explode("=",$arg); $arg = '';
            $key = str_replace("--",'',$str[0]);
            for ( $i = 1; $i < count($str); $i++ ) {
                $arg .= $str[$i];
            }
            $_ARG[$key] = $arg;
        } elseif(preg_match('/-[a-zA-Z0-9]/',$arg)) {
            $arg = str_replace("-",'',$arg);
            $_ARG[$arg] = 'true';
        }
    }
    return $_ARG;
}