report_asset_statuses_edit_fns.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/report/report_edit_fns.inc';
require_once SQ_FUDGE_PATH.'/general/file_system.inc';

class Report_Asset_Statuses_Edit_Fns extends Report_Edit_Fns
{


    function __construct()
    {
        parent::__construct();

    }//end constructor


    function generateReport(&$job, &$step_data, $prefix)
    {
        $am = $GLOBALS['SQ_SYSTEM']->am;
        $db = MatrixDAL::getDb();
        $owner = $am->getAsset($job->_running_vars['assetid'], 'report_asset_statuses');
        $where = Array();
        $tables = Array('sq_ast a');

        $root_link = $GLOBALS['SQ_SYSTEM']->am->getLink($owner->id, SQ_LINK_NOTICE, '', FALSE, 'root');
        if (!empty($root_link)) {
            // need to restrict results according to link tree position too
             try {
                $bind_vars['root_link_minorid'] = $root_link['minorid'];
                $parent_treeid = MatrixDAL::executeOne('cms_package', 'getTreeidFromMinor', $bind_vars);
            } catch (Exception $e) {
                throw new Exception('Unable to get tree id from minor id: '.$e->getMessage());
            }
            $where[] = 'SUBSTR(t.treeid, 1, '.strlen($parent_treeid).') = '.MatrixDAL::quote($parent_treeid);
            $tables[] = 'sq_ast_lnk l';
            $tables[] = 'sq_ast_lnk_tree t';
            $where[] = 'l.linkid = t.linkid';
            $where[] = 'a.assetid = l.minorid';
        }

        $search_status = str_replace('|', ', ', $owner->attr('search_status'));
        if ($search_status != SQ_SC_STATUS_ALL) {
            $where[] = 'a.status in ('.$search_status.')';
        }

        $period_length = $owner->attr('status_change_period');
        if ($period_length) {
            $operator = $owner->attr('status_change_comparator_more_than') ? '<' : '>';
            $timestamp = time() - $period_length;
            $where[] = 'a.status_changed '.$operator.' '.db_extras_todate(MatrixDAL::getDbType(), ts_iso8601($timestamp));
        }

        $sql = 'SELECT
                    a.assetid, a.type_code, a.name, a.status, a.status_changed, a.status_changed_userid
                FROM
                    '.implode(', ', $tables).'
                WHERE
                    ('.implode(') AND (', $where).')
                ORDER BY
                    a.type_code';
        $query = MatrixDAL::preparePdoQuery($sql);
        $result = MatrixDAL::executePdoAssoc($query);

        if (empty($result)) {
            $step_data['percent_done'] = 100;
            $step_data['complete']     = TRUE;
            $job->_addError('No assets were found matching your criteria', TRUE);
            return FALSE;
        }
        // find the users' names
        $userids = Array();
        foreach ($result as $r) {
            if (!empty($r['status_changed_userid']) && (FALSE === strpos($r['status_changed_userid'], ':'))) {
                $userids[] = $r['status_changed_userid'];
            }
        }
        $names = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($userids, Array(), FALSE, 'name');
        foreach ($result as $i => $r) {
            if (isset($names[$r['status_changed_userid']])) {
                $result[$i]['user_name'] = array_get_index($names, $r['status_changed_userid'], 'Unknown');
            } else if (!empty($r['status_changed_userid'])) {
                $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($r['status_changed_userid']);
                $result[$i]['user_name'] = $asset->name;
            } else {
                $result[$i]['user_name'] = 'Unknown';
            }
        }

        // generate XML contents
        $contents = '<?xml version="1.0" encoding="'.SQ_CONF_DEFAULT_CHARACTER_SET.'"?>'."\n";
        $contents .= '<asset_list>'."\n";
        foreach ($result as $values) {
            $contents .= '<asset assetid="'.htmlSpecialChars($values['assetid']).'" name="'.htmlSpecialChars($values['name']).'" type_code="'.$values['type_code'].'">'."\n";
            $contents .= '  <status value="'.$values['status'].'" changed="'.$values['status_changed'].'" changed_userid="'.htmlSpecialChars($values['status_changed_userid']).'" changed_user_name="'.htmlSpecialChars($values['user_name']).'"/>'."\n";
            $contents .= '</asset>'."\n";
        }
        $contents .= '</asset_list>';

        $report_dir = $owner->data_path;
        $xml_file_name = $report_dir.'/report.xml';

        if (!is_dir($report_dir)) {
            if (!create_directory($report_dir)) {
                trigger_localised_error('CORE0198', E_USER_WARNING);
                return FALSE;
            }
        }

        // file manipulation section
        $file_handler = fopen($xml_file_name, 'w');
        if ($file_handler === FALSE) {
            trigger_localised_error('CORE0017', E_USER_WARNING);
            return FALSE;
        }
        fwrite($file_handler, $contents);
        fclose($file_handler);

        $step_data['percent_done'] = 100;
        $step_data['complete']     = TRUE;

        unset($owner->_tmp['getAssetMapLinks']);
        unset($owner->_tmp['getLinks']);
        return TRUE;

    }//end generateReport()


    function paintLastStatusChange(&$asset, &$o, $prefix)
    {
        $write_access = $asset->writeAccess('attributes');

        $comparator_attr = $asset->getAttribute('status_change_comparator_more_than');
        $comparator_attr->setEditParam('true_text', 'more');
        $comparator_attr->setEditParam('false_text', 'less');
        $comparator_attr->paint($prefix.'_comparator', !$write_access);
        echo ' than ';
        $comparator_attr = $asset->getAttribute('status_change_period');
        $comparator_attr->paint($prefix.'_period', !$write_access);
        echo ' ago';
        return TRUE;

    }//end paintLastStatusChange()


    function processLastStatusChange(&$asset, &$o, $prefix)
    {
        $comparator_attr = $asset->getAttribute('status_change_comparator_more_than');
        $comparator_attr->process($prefix.'_comparator');
        $asset->setAttrValue('status_change_comparator_more_than', $comparator_attr->value);
        $period_attr = $asset->getAttribute('status_change_period');
        $period_attr->process($prefix.'_period');
        $asset->setAttrValue('status_change_period', $period_attr->value);
        return TRUE;

    }//end processLastStatusChange()


    function paintReport(&$asset, &$o, $prefix)
    {
        $am = $GLOBALS['SQ_SYSTEM']->am;

        require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
        $report_path = $asset->data_path.'/report.xml';

        if (!is_file($report_path)) {
            echo 'This report has not been generated';
            return;
        }

        try {
            $root = new SimpleXMLElement($report_path, LIBXML_NOCDATA, TRUE);
        } catch (Exception $e) {
             throw new Exception('Unable to parse report file "'.$report_path.'": '.$e->getMessage());
            // trigger_localised_error('CORE0092', E_USER_WARNING, $report_path, $root->getMessage(), $root->getUserInfo());
            return;
        }

        ?>
        <table class="sq-backend-table">
            <tr>
                <th class="sq-backend-table-header" style="width: 10ex"><?php echo translate('cms_reports_asset_statuses_asset_icon'); ?></th>
                <th class="sq-backend-table-header" style="width: 10ex"><?php echo translate('assetid'); ?></th>
                <th class="sq-backend-table-header"><?php echo translate('name'); ?></th>
                <th class="sq-backend-table-header"><?php echo translate('status'); ?></th>
                <th class="sq-backend-table-header"><?php echo translate('cms_reports_asset_statuses_last_status_change'); ?></th>
                <th class="sq-backend-table-header"><?php echo translate('cms_reports_asset_statuses_last_status_changer'); ?></th>
            </tr>
        <?php

        foreach ($root->asset as $asset_node) {
            $assetid = (int) $asset_node->attributes()->assetid;
            $name = (string) $asset_node->attributes()->name;
            $type_code = (string) $asset_node->attributes()->type_code;
            $type_icon = $am->getAssetIconURL($type_code);

            $status = (int) $asset_node->status->attributes()->value;
            $status_changed = (string) $asset_node->status->attributes()->changed;
            $status_changed_userid = (int) $asset_node->status->attributes()->changed_userid;
            $status_changed_user_name = (string) $asset_node->status->attributes()->changed_user_name;

            ?>
                <tr>
                    <td class="sq-backend-table-cell">
                        <script type="text/javascript">sq_print_icon("<?php echo $type_icon; ?>", "16", "16", "");</script>
                    </td>
                    <td class="sq-backend-table-cell">
                        <?php echo htmlspecialchars($assetid); ?>
                    </td>
                    <td class="sq-backend-table-cell">
                        <?php echo htmlspecialchars($name); ?>
                    </td>
                    <td class="sq-backend-table-cell">
                        <?php echo get_asset_status_icon($status); ?><?php echo get_status_description($status); ?>
                    </td>
                    <td class="sq-backend-table-cell">
                        <?php echo $status_changed; ?>
                    </td>
                    <td class="sq-backend-table-cell">
                        <?php echo htmlspecialchars($status_changed_user_name); ?> [<?php echo htmlspecialchars($status_changed_userid); ?>]
                    </td>
                </tr>
            <?php
        }//end foreach
        ?>
        </table>
        <?php

    }//end paintReport()


    function paintSearchStatuses(&$asset, &$o, $prefix)
    {
        $write_access = $asset->writeAccess('attributes');
        $current_statuses = explode('|',$asset->attr('search_status'));

        if ($write_access) {
            $statuses = get_constant_values('SQ_STATUS');
            $options = Array();
            foreach ($statuses as $constant => $value) {
                $options[$value] = get_status_description($value);
            }
            combo_box($prefix.'_statuses', $options, TRUE, $current_statuses);
        } else {
            if (empty($current_statuses)) {
                echo translate('cms_listing_no_status_selected');
            } else {
                ?><ul style="margin: 1px 15px;"><?php
                foreach ($current_statuses as $status) {
                    echo '<li>';
                    echo get_asset_status_icon($status);
                    echo get_status_description($status);
                    echo '</li>';
                }
                ?></ul><?php
            }
        }

    }//end paintSearchStatuses()


    function processSearchStatuses(&$asset, &$o, $prefix)
    {
        $new_statuses = Array();
        if (isset($_REQUEST[$prefix.'_statuses'])) {
            $new_statuses = implode('|', $_REQUEST[$prefix.'_statuses']);
            $asset->setAttrValue('search_status', $new_statuses);
        }

    }//end processSearchStatuses()


}//end class

?>