include/generic/SugarWidgets/SugarWidgetReportField.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39
  40
  41
  42
  43 $used_aliases = array();
  44 $alias_map = array();
  45
  46 class SugarWidgetReportField extends SugarWidgetField
  47 {
  48     /**
  49      * Layout manager reporter attribute
  50      * @var SugarBean
  51      */
  52     protected $reporter;
  53
  54         function SugarWidgetReportField(&$layout_manager) {
  55         parent::SugarWidgetField($layout_manager);
  56         $this->reporter = $this->layout_manager->getAttribute("reporter");
  57     }
  58
  59         function  getSubClass($layout_def)
  60         {
  61                 if (! empty($layout_def['type']))
  62                 {
  63
  64                         if ($layout_def['type'] == 'time') {
  65                                 $layout_def['widget_class'] = 'Fielddate';
  66                         } else {
  67                                 $layout_def['widget_class'] = 'Field'.$layout_def['type'];
  68                         }
  69                         return $this->layout_manager->getClassFromWidgetDef($layout_def);
  70                 } else {
  71                         return $this;
  72                 }
  73         }
  74
  75
  76  function display($layout_def)
  77  {
  78         $obj = $this->getSubClass($layout_def);
  79
  80         $context = $this->layout_manager->getAttribute('context');//_ppd($context);
  81         $func_name = 'display'.$context;
  82
  83
  84         if ( ! empty($context) && method_exists($obj,$func_name))
  85         {
  86                 return  $obj->$func_name($layout_def);
  87         } else
  88         {
  89                 return 'display not found:'.$func_name;
  90         }
  91  }
  92
  93  function _get_column_select_special($layout_def)
  94  {
  95                 $alias = '';
  96                  if ( ! empty($layout_def['table_alias']))
  97                  {
  98                         $alias = $layout_def['table_alias'];
  99                  }
 100
 101     if ($layout_def['name'] == 'weighted_sum' )
 102     {
 103         return sprintf("SUM(%s * %s * 0.01)", $this->reporter->db->convert("$alias.probability","IFNULL", array(0)),
 104             $this->reporter->db->convert("$alias.amount_usdollar","IFNULL", array(0)));
 105         }
 106     if ($layout_def['name'] == 'weighted_amount' )
 107     {
 108         return sprintf("AVG(%s * %s * 0.01)", $this->reporter->db->convert("$alias.probability","IFNULL", array(0)),
 109             $this->reporter->db->convert("$alias.amount_usdollar","IFNULL", array(0)));
 110         }
 111  }
 112
 113  function _get_column_select($layout_def)
 114  {
 115         global $reportAlias;
 116         if (!isset($reportAlias)) {
 117                 $reportAlias = array();
 118         }
 119
 120         if ( ! empty($layout_def['table_alias'])) {
 121                 $alias = $layout_def['table_alias'].".".$layout_def['name'];
 122         } else if (! empty($layout_def['name'])) {
 123                 $alias = $layout_def['name'];
 124         } else {
 125                 $alias = "*";
 126         }
 127
 128         if ( ! empty($layout_def['group_function']) )
 129         {
 130         if ($layout_def['name'] == 'weighted_sum' || $layout_def['name'] == 'weighted_amount')
 131         {
 132                         $alias = $this->_get_column_select_special($layout_def);
 133                         $reportAlias[$alias] = $layout_def;
 134                                 return $alias;
 135         }
 136
 137         $alias = $this->reporter->db->convert($alias, 'IFNULL', array(0));
 138
 139         // for a field with type='currency' conversion of values into a user-preferred currency
 140         if ($layout_def['type'] == 'currency' && strpos($layout_def['name'], '_usdoll') === false) {
 141             $currency = $this->reporter->currency_obj;
 142             $currency_alias = isset($layout_def['currency_alias'])
 143                 ? $layout_def['currency_alias'] : $currency->table_name;
 144             $query = $this->reporter->db->convert($currency_alias.".conversion_rate", "IFNULL", array(1));
 145             $alias = "{$layout_def['group_function']}($alias/{$query})*{$currency->conversion_rate}";
 146         } else {
 147             $alias = "{$layout_def['group_function']}($alias)";
 148         }
 149         }
 150
 151         $reportAlias[$alias] = $layout_def;
 152         return $alias;
 153  }
 154
 155  function querySelect(&$layout_def)
 156  {
 157     return $this->_get_column_select($layout_def)." ".$this->_get_column_alias($layout_def)."\n";
 158  }
 159
 160  function queryGroupBy($layout_def)
 161  {
 162         return $this->_get_column_select($layout_def)." \n";
 163  }
 164
 165
 166  function queryOrderBy($layout_def)
 167  {
 168         if(!empty($this->reporter->all_fields[$layout_def['column_key']])) $field_def = $this->reporter->all_fields[$layout_def['column_key']];
 169
 170     if (!empty($layout_def['group_function']))
 171     {
 172         $order_by = $this->_get_column_alias($layout_def);
 173     }
 174     elseif (!empty($field_def['sort_on']))
 175         {
 176                         $order_by = $layout_def['table_alias'].".".$field_def['sort_on'];
 177             if(!empty($field_def['sort_on2']))
 178                 $order_by .= ', ' . $layout_def['table_alias'].".".$field_def['sort_on2'];
 179     }
 180         else {
 181                 $order_by = $this->_get_column_alias($layout_def)." \n";
 182         }
 183
 184                         if ( empty($layout_def['sort_dir']) || $layout_def['sort_dir'] == 'a')
 185                         {
 186                                 return $order_by." ASC";
 187                         } else {
 188                                 return $order_by." DESC";
 189                         }
 190  }
 191
 192
 193  function queryFilter($layout_def)
 194  {
 195         $method_name = "queryFilter".$layout_def['qualifier_name'];
 196         return $this->$method_name($layout_def);
 197  }
 198
 199         function displayHeaderCell($layout_def)
 200         {
 201                                 global $start_link_wrapper,$end_link_wrapper;
 202
 203
 204                 // don't show sort links if name isn't defined
 205                 $no_sort = $this->layout_manager->getAttribute('no_sort');
 206                 if(empty($layout_def['name']) || ! empty($no_sort) || ! empty($layout_def['no_sort']))
 207                 {
 208                         return $layout_def['label'];
 209                 }
 210
 211
 212
 213                 $sort_by ='';
 214                 if ( ! empty($layout_def['table_key']) && ! empty($layout_def['name']) ) {
 215                         if (! empty($layout_def['group_function']) && $layout_def['group_function'] == 'count') {
 216                         $sort_by = $layout_def['table_key'].":".'count';
 217                         } else {
 218                         $sort_by = $layout_def['table_key'].":".$layout_def['name'];
 219                         if ( ! empty($layout_def['column_function'])) {
 220                                 $sort_by .= ':'.$layout_def['column_function'];
 221                                 } else if ( ! empty($layout_def['group_function']) ) {
 222                                 $sort_by .= ':'.$layout_def['group_function'];
 223                                 }
 224                         }
 225                 } else {
 226                         return $this->displayHeaderCellPlain($layout_def);
 227                 }
 228
 229                 $start = empty($start_link_wrapper) ? '': $start_link_wrapper;
 230                                 $end = empty($end_link_wrapper) ? '': $end_link_wrapper;
 231
 232                 // unable to retrieve the vardef here, exclude columns of type clob/text from being sortable
 233
 234                 if(!in_array($layout_def['name'], array('description', 'account_description', 'lead_source_description', 'status_description', 'to_addrs', 'cc_addrs', 'bcc_addrs', 'work_log', 'objective', 'resolution'))) {
 235                     $header_cell = "<a class=\"listViewThLinkS1\" href=\"".$start.$sort_by.$end."\">";
 236                     $header_cell .= $this->displayHeaderCellPlain($layout_def);
 237                     $header_cell .= ListView::getArrowUpDownStart(isset($layout_def['sort']) ? $layout_def['sort'] : '');
 238                     $header_cell .= ListView::getArrowUpDownEnd(isset($layout_def['sort']) ? $layout_def['sort'] : '');
 239                             $header_cell .= "</a>";
 240                                         return $header_cell;
 241                                 }
 242
 243                         return $this->displayHeaderCellPlain($layout_def);
 244     }
 245
 246         function query($layout_def)
 247         {
 248                  $obj = $this->getSubClass($layout_def);
 249
 250                 $context = $this->layout_manager->getAttribute('context');
 251                 $func_name = 'query'.$context;
 252
 253                 if ( ! empty($context) && method_exists($obj,$func_name))
 254                  {
 255                          return  $obj->$func_name($layout_def);
 256                 } else
 257                 {
 258                         return '';
 259                 }
 260         }
 261
 262  function _get_column_alias($layout_def)
 263  {
 264         $alias_arr = array();
 265
 266         if (!empty($layout_def['table_key']) && $layout_def['table_key'] == 'self' && !empty($layout_def['name']) && $layout_def['name'] == 'id')
 267         {
 268                 return 'primaryid';
 269         }
 270
 271      // Bug: 44605
 272      // this comment is being added to trigger the upgrade package
 273         if ( ! empty($layout_def['group_function']) && $layout_def['group_function']=='count')
 274         {
 275                 return $layout_def['table_alias'] . '__count';
 276         }
 277
 278         if ( ! empty($layout_def['table_alias']))
 279         {
 280                 array_push($alias_arr,$layout_def['table_alias']);
 281         }
 282
 283         if ( ! empty($layout_def['group_function']) && $layout_def['group_function'] != 'weighted_amount' && $layout_def['group_function'] != 'weighted_sum')
 284         {
 285                 array_push($alias_arr,$layout_def['group_function']);
 286         } else if ( ! empty($layout_def['column_function']))
 287         {
 288                 array_push($alias_arr,$layout_def['column_function']);
 289         } else if ( ! empty($layout_def['qualifier']))
 290         {
 291                 array_push($alias_arr,$layout_def['qualifier']);
 292         }
 293
 294         if ( ! empty($layout_def['name']))
 295         {
 296                 array_push($alias_arr,$layout_def['name']);
 297         }
 298
 299                 global $used_aliases, $alias_map;
 300
 301         $alias = strtolower(implode("_",$alias_arr));
 302
 303         $short_alias = $this->getTruncatedColumnAlias($alias);
 304
 305                 if ( empty($used_aliases[$short_alias]))
 306                 {
 307                         $alias_map[$alias] = $short_alias;
 308                     $used_aliases[$short_alias] = 1;
 309                 return $short_alias;
 310                 } else if ( ! empty($alias_map[$alias]) )
 311                 {
 312                         return $alias_map[$alias];
 313                 } else {
 314                         $alias_map[$alias] = $short_alias.'_'.$used_aliases[$short_alias];
 315                   $used_aliases[$short_alias]++;
 316                         return $alias_map[$alias];
 317                 }
 318  }
 319
 320  function queryFilterEmpty($layout_def)
 321  {
 322      $column = $this->_get_column_select($layout_def);
 323      return "($column IS NULL OR $column = ".$this->reporter->db->emptyValue($layout_def['type']).")";
 324  }
 325
 326  function queryFilterIs($layout_def)
 327  {
 328         return '( '.$this->_get_column_select($layout_def)."='".$GLOBALS['db']->quote($layout_def['input_name0'])."')\n";
 329  }
 330
 331  function queryFilteris_not($layout_def)
 332  {
 333         return '( '.$this->_get_column_select($layout_def)."<>'".$GLOBALS['db']->quote($layout_def['input_name0'])."')\n";
 334  }
 335
 336  function queryFilterNot_Empty($layout_def)
 337  {
 338      $column = $this->_get_column_select($layout_def);
 339      return "($column IS NOT NULL AND $column <> ".$this->reporter->db->emptyValue($layout_def['type']).")";
 340  }
 341
 342 }