/Applications/XAMPP/xamppfiles/htdocs/researchdb/modules/summary/actions/summary_page.php

Go to the documentation of this file.

<?php
/*
 * Xataface Summary Module
 * 
 * Copyright (C) 2011  Steve Hannah <shannah@sfu.ca>
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 */
 
class actions_summary_page {

        private $table;
        
        private $groupFuncs;
        
        private $mod;
        
        private $selectedSummaryCols;
        
        private $groupBy;


        function handle($params){
        
                $app = Dataface_Application::getInstance();
                $query = $app->getQuery();
                $mod = Dataface_ModuleTool::getInstance()->loadModule('modules_summary');
                $this->mod = $mod;
                
                // Now work on our dependencies
                $mt = Dataface_ModuleTool::getInstance();
                
                // We require the XataJax module
                // The XataJax module activates and embeds the Javascript and CSS tools
                $mt->loadModule('modules_XataJax', 'modules/XataJax/XataJax.php');
                
                $jt = Dataface_JavascriptTool::getInstance();
                $jt->addPath(dirname(__FILE__).'/../js', $mod->getBaseURL().'/js');
                
                $ct = Dataface_CSSTool::getInstance();
                $ct->addPath(dirname(__FILE__).'/../css', $mod->getBaseURL().'/css');
                
                // Add our javascript
                $jt->import('xataface/modules/summary/summary-page.js');
                
                
                $table = Dataface_Table::loadTable($query['-table']);
                $this->table = $table;
                
                // Let's get all of the table columns
                $fields = $table->fields(false, true, false);
                $summaryFields = $mod->getSummaryFields($table);
                
                
                $groupableFields = array();
                $summarizableFields = array();
                $temp = array();
                
                foreach ($summaryFields as $k=>$v){
                        $perms = $table->getPermissions(array('field'=>$k));
                        if ( @$perms['summary view']){
                                $temp[$k] = $v;
                        }
                        
                }
                $summaryFields = $temp;
                
                
                foreach ($fields as $k=>$v){
                        $perms = $table->getPermissions(array('field'=>$k));
                        if ( @$perms['summary group'] and @$perms['summary view'] ){
                                $groupableFields[$k]=$v;
                        }
                        if ( @$perms['summary view'] ){
                                $summarizableFields[$k] = $v;
                                
                        }
                }
                
                $groupFuncs = array(
                        'min'=>array(
                                'label'=>'Min',
                                'description'=>'Show minimum value in set.',
                                'param'=>'min(%s)',
                                'types'=>array(
                                        'all'
                                )
                        ),
                        'max'=>array(
                                'label'=>'Max',
                                'description'=>'Show the maximum value in set.',
                                'param'=>'max(%s)',
                                'types'=>array(
                                        'all'
                                )
                        ),
                        'avg'=>array(
                                'label'=>'Avg',
                                'description'=>'Show the average value of this column in the set.',
                                'param'=>'avg(%s)',
                                'types'=>array(
                                        'all'
                                )
                        ),
                        'sum'=>array(
                                'label'=>'Sum',
                                'description'=>'Show the sum of all rows for this column.',
                                'param'=>'sum(%s)',
                                'types'=>array(
                                        'all'
                                )
                        ),
                        'count'=>array(
                                'label'=>'Count',
                                'description'=>'Counts the number of rows in teh set.',
                                'param'=>'count(%s)',
                                'types'=>array('all')
                        
                        ),
                        'count-distinct',array(
                                'label'=>'Count (distinct)',
                                'description'=>'Counts the number of distinct values in this column in the set.',
                                'param'=>'count(distinct %s)',
                                'types'=>array('all')
                        ),
                        'std'=>array(
                                'label'=>'Std',
                                'description'=>'Standard deviation of this column in the set.',
                                'param'=>'std(%s)',
                                'types'=>array('all')
                        )
                );
                
                $this->groupFuncs =& $groupFuncs;
                
                
                
                
                // Now for the result set
                
                $groupBy = array();
                if ( @$_GET['-group-by'] ){
                        $groupBy = explode(',', $_GET['-group-by']);
                        
                }
                foreach ($groupBy as $key=>$val){
                        if ( !isset($groupableFields[$val]) ){
                                unset($groupBy[$key]);
                        }
                }
                
                $this->groupBy =& $groupBy;
                
                $selectedSummaryCols = null;
                if ( @$_GET['-summary-cols'] ){
                        $selectedSummaryCols = explode(',', $_GET['-summary-cols']);
                }
                if ( !$selectedSummaryCols ){
                        $selectedSummaryCols = array_keys($mod->getSummaryFields($table));
                        
                }
                $this->selectedSummaryCols =& $selectedSummaryCols;
                $graftedSummaryColumnDefs = array();
                
                if ( $selectedSummaryCols ){
                        foreach ($selectedSummaryCols as $key=>$col){
                                if ( preg_match('/^([^\)]+)\(([^\)]+)\)$/', $col, $matches) ){
                                        // THis is a calculated field passed through the GET parameters
                                        // so we need to parse it out and add it as a proper summary field.
                                        $paramField = $matches[2];
                                        $funcName = $matches[1];
                                        
                                        if ( !isset($groupFuncs[$funcName]) ){
                                                unset($selectedSummaryCols[$key]);
                                                continue;
                                        }
                                        
                                        if ( !isset($summarizableFields[$paramField]) ){
                                                unset($selectedSummaryCols[$key]);
                                                continue;
                                        }
                                        
                                        $fieldDef =& $summarizableFields[$paramField];
                                        
                                        $graftedSummaryColumnDefs[$paramField.'__'.$funcName] = array(
                                                'formula'=> sprintf($groupFuncs[$funcName]['param'], '`'.$paramField.'`'),
                                                'widget'=>array('label'=>$groupFuncs[$funcName]['label'].'('.$fieldDef['widget']['label'].')'),
                                                'name'=>$paramField.'__'.$funcName
                                        );
                                        unset($selectedSummaryCols[$key]);
                                        $selectedSummaryCols[] = $paramField.'__'.$funcName;
                                        
                                        
                                }
                        }
                }
                
                $summaryFieldsRef =& $mod->getSummaryFields($table);
                
                foreach ($graftedSummaryColumnDefs as $key=>$val){
                        $summaryFieldsRef[$key] = $val;
                }
                
                //print_r($graftedSummaryColumnDefs);
                if ( $selectedSummaryCols ){
                        $sql = $mod->getSummarySQL($table, $query, $groupBy, $selectedSummaryCols);
                        //echo $sql;exit;
                        $res = mysql_query($sql, df_db());
                        if ( !$res ){
                                throw new Exception(mysql_error(df_db()));
                        }
                        $rows = array();
                        while ($row = mysql_fetch_assoc($res) ){
                                $rows[] = $row;
                        }
                        @mysql_free_result($res);
                } else {
                        $rows = array();
                }
                
                
                
                
                
                
                $context = array(
                        'summaryFields'=>$summaryFields,
                        'groupableFields'=>$groupableFields,
                        'summarizableFields'=>$summarizableFields,
                        'groupFuncs'=> $groupFuncs,
                        'self'=>$this,
                        'rows'=>$rows,
                        'numResults'=>$app->getResultSet()->found(),
                        'table'=>$table,
                                
                        'groupBy'=>($groupBy?$groupBy:array())
                );
                
                df_register_skin('modules_summary', dirname(__FILE__).'/../templates');
                df_display($context, 'xataface/modules/summary/main.html');
                        
                        
                
                
                
                
                
        }
        
        
        function supports($fieldname, $funcname){
                $func = @$this->groupFuncs[$funcname];
                if ( !$func ) return false;
                if ( !@$func['types'] ) return false;
                if ( !is_array($func['types']) ) return false;
                
                if ( $this->table->exists($fieldname) ){
                        if ( in_array('all', $func['types']) ) return true;
                        if ( ($this->table->isInt($fieldname) or $this->table->isFloat($fieldname)) and in_array('numeric', $func['types']) ){
                                return true;
                        }
                } else {
                        $sf =& $this->mod->getSummaryFields($this->table);
                        if ( !isset($sf[$fieldname]) ) return false;
                        if ( in_array('formula', $func['types']) ){
                                return true;
                        }
                }
                return false;
                
        }
        
        function getSummaryLabel($col){
                $f =& $this->mod->getSummaryField($this->table, $col);
                if ( $f and @$f['label'] ) return $f['label'];
                if ( $f and @$f['widget'] and @$f['widget']['label'] ) return $f['widget']['label'];
                
                return $col;
        }
        
        
        function getFieldLabel($col){ 
                $f = $this->table->getField($col);
                if ( $f and @$f['widget']['label'] ){
                        return $f['widget']['label'];
                }
                return $col;
        }
        
        function isSelectedGroupField($fieldname){
                return in_array($fieldname, $this->groupBy);
        }
        
        function isSelectedSummaryField($fieldname, $func=null){
                if ( !is_array($this->selectedSummaryCols) ) return false;
                if ( isset($func) ){
                        $fieldname .= '__'.$func;
                }       
                return in_array($fieldname, $this->selectedSummaryCols);
        }
        
        function get($array, $key){ return $array[$key]; }
        
        function getSelectedSummaryColumns(){ 
                //print_r($this->selectedSummaryCols);
                return $this->selectedSummaryCols;
        }
        
        
        function getCellValue($fieldname, $value){
                if ( $this->table->hasField($fieldname) ){
                        $rec = new Dataface_Record($this->table->tablename, array($fieldname=>$value));
                        return $rec->display($fieldname);
                } else {
                        return $value;
                }
        }
        
        function explainQueryParam($label, $value){
                $l = $label;
                $v = $value;
                $fc = $v{0};
                if ( $fc == '=' ){
                        if ( strlen($v)===1 ){
                                return $l.' is blank';
                        }
                        return  $l.' = "'.substr($v,1).'"';
                } else if ( $fc == '>' and @$v{1} != '='){
                        if ( strlen($v)===1 ){
                                return  $l.' is not blank';
                        }
                        return  $l.' > "'.substr($v,1).'"';
                } else if ( $fc == '<' and @$v{1} != '=' ){
                        return  $l.' < "'.substr($v,1).'"';
                } else if ( $fc == '>' and @$v{1} == '='){
                        
                        return  $l.' >= "'.substr($v,2).'"';
                } else if ( $fc == '<' and @$v{1} == '=' ){
                        return $l.' <= "'.substr($v,2).'"';
                } else if ( $fc == '~' ){
                        return $l.' matches pattern "'.substr($v,1).'"';
                } else if ( $parts = explode('..', $v) and count($parts) > 1 ){
                        return $l.' is between "'.$parts[0].'" and "'.$parts[1].'"';
                } else if ( $this->table->isInt($k) or $this->table->isFloat($k) ){
                        return $l.' = '.$v;
                } else {
                        return $l.' contains "'.$v.'"';
                }
        
        }
        
        function getCurrentFilters(){
                $app = Dataface_Application::getInstance();
                $query = $app->getQuery();
                
                $filter = array();
                foreach ($query as $k=>$v){
                        if ( !isset($v) or $v === '' ) continue;
                        if ( $this->table->hasField($k) ){
                                
                        
                                $fld = $this->table->getField($k);
                                $l = $fld['widget']['label'];
                                $filter[$k] = $this->explainQueryParam($l, $v);
                                
                                
                        } else if ( strpos($k,'/') !== false ){
                                // We may have a related field query.
                                list($rel,$fld) = explode('/', $k);
                                if ( $this->table->hasRelationship($rel) ){
                                        $relObj = $this->table->getRelationship($rel);
                                        if ( $relObj->hasField($fld, true) ){
                                                $fldDef = $relObj->getField($fld);
                                                if ( PEAR::isError($fldDef) ) continue;
                                                $l = $fldDef['widget']['label'];
                                                $filter[$k] = $relObj->getLabel().' contains a related record with '.$this->explainQueryParam($l, $v); 
                                                
                                        }
                                }
                        
                        }
                }
                return $filter;
        }
}