Stable merged into unstable again (due to failure on binary file during previous...
[fa-stable.git] / reporting / includes / reports_classes.inc
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License, GPL, 
5         as published by the Free Software Foundation, either version 3 
6         of the License, or (at your option) any later version.
7     This program is distributed in the hope that it will be useful,
8     but WITHOUT ANY WARRANTY; without even the implied warranty of
9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12
13 // Standard report classess
14 define('RC_CUSTOMER', 0);
15 define('RC_SUPPLIER', 1);
16 define('RC_INVENTORY', 2);
17 define('RC_MANUFACTURE', 3);
18 define('RC_DIMENSIONS', 4);
19 define('RC_BANKING', 5);
20 define('RC_GL', 6);
21
22 class BoxReports
23 {
24         var $ar_classes; // report class names
25         var $ar_reports;
26         var $ctrl_handlers = array();
27
28         function ReportClasses()
29         {
30                 $this->ar_classes = array();
31         }
32
33         function addReportClass($class_name, $class_id=null)
34         {
35                 if (!$class_id)
36                         $class_id = count($this->ar_classes);
37                 $this->ar_classes[$class_id] = $class_name;
38
39                 return $class_id;
40         }
41
42         function addReport($class, $id, $rep_name, $params=null)
43         {
44                 unset($this->ar_reports[$class][$id]); // unset std report if any
45                 $this->ar_reports[$class][$id] = new Report($id, $rep_name, $params);
46         }
47
48         function getDisplay($class=null)
49         {
50                 global $path_to_root, $pdf_debug, $Ajax;
51
52                 if (find_submit('Rep') != -1) {
53                         include($path_to_root.'/reporting/prn_redirect.php');
54                         return;
55                 }
56
57                 $temp = array_values($this->ar_classes);
58                 $display_class = $class==null ? $temp[0] : $this->ar_classes[$class];
59                 $st_reports = "";
60                 $st_params = "";
61                 $st_classes = "<b>" . _("Report Classes:") . "</b><br>";
62
63                 if (isset($_GET['Class']))
64                         set_focus('class'.$_GET['Class']);
65
66                 $cur_class = $_REQUEST['Class'];
67
68                 foreach($this->ar_classes as $class_id => $name)
69                 {
70                         if (!isset($this->ar_reports[$class_id]))
71                                 continue; // e.g. no dimensions
72
73                         $acc = access_string($name);
74                         $st_classes .= "<a href='"
75                                 .$_SERVER['PHP_SELF']."?Class=$class_id'"
76                                 ." style='font-weight:". ($cur_class == $class_id ? 'bold' : 'normal')."'"
77                                 ." class='repclass_link' id='".'class'.$class_id."'"
78                                 ."$acc[1]>$acc[0]</a> <br>";
79
80                         $style = $class_id==$cur_class ? '' : "style='display:none'";
81                         $st_reports .= "<table class='repclass' id='TAB_" . $class_id ."' $style cellpadding=0 cellspacing=0 border=0 width='100%'><tr><td><b>" . _("Reports For Class: ") . "&nbsp;$name</b></td></tr>\n";
82                         foreach($this->ar_reports[$class_id] as $rep_id => $report)
83                         {
84                                 $acc = access_string($report->name);
85                                 $st_reports .= "<tr><td><a class='repopts_link'"
86                                         ." href='".$_SERVER['PHP_SELF']."?Class=$class_id&REP_ID=$report->id'"
87                                         ." style='font-weight:". (@$_REQUEST['REP_ID'] == $report->id ? 'bold' : 'normal')."'"
88                                         ." id='".$id = default_focus()."'"
89                                         ."$acc[1]>$acc[0]</a><tr><td>\n";
90
91                                 if (@$_REQUEST['REP_ID'] == $report->id) {
92                                         $Ajax->activate($id);
93                                 }
94
95                                 if (isset($_REQUEST['REP_ID']) && $_REQUEST['REP_ID']==$report->id) {
96                                         // parameters form
97                                         $action = $_SERVER['PHP_SELF'];
98                                         $st_params = "<table><tr><td>\n"
99                                                 . "<form method='POST' action='$action' target='_blank'>\n";
100                                         $st_params .= submit('Rep'.$report->id,  
101                                                 _("Display: ") . access_string($report->name, true),
102                                                 false, '', $pdf_debug ? false : 'default process') . hidden('REP_ID', $report->id, false).'<br><br>';
103                                         $st_params .= $this->getOptions($report->get_controls(), $report->id);
104                                         $st_params .= "\n<input type=hidden name='Class' value=".$cur_class.">"
105                                                 ."\n</form></td></tr></table>\n";
106                                         set_focus('Rep'.$report->id);
107                                         $Ajax->addUpdate(true, 'rep_form', $st_params);
108                                 }
109                         }
110                         $st_reports .= "</table>";
111                 }
112
113                 $st_params = "<div id='rep_form'>".
114                         "$st_params</div>";
115                 
116                 $st = "<table align='center' width='80%' style='border:1px solid #cccccc;'><tr valign='top'>";
117                 $st .= "<td width='30%'>$st_classes</td>";
118                 $st .= "<td width='35%' style='border-left:1px solid #cccccc;border-right:1px solid #cccccc;padding-left:3px;'>$st_reports</td>";
119                 $st .= "<td width='35%'>$st_params</td>";
120                 $st .= "</tr></table><br>";
121
122                 return $st;
123         }
124
125         function getOptions($controls, $id = 0)
126         {
127                 $st = '';
128                 if ($controls == null)
129                         return "";
130
131                 $cnt = 0;
132                 foreach($controls as $title => $type)
133                 {
134                         $ctrl = '';
135                         foreach($this->ctrl_handlers as $fun) { // first check for non-standard controls
136                                 $ctrl = $fun('PARAM_'.$cnt, $type);
137                                 if ($ctrl) break;
138                         }
139                         if ($ctrl == '') {
140                                 if (isset($_COOKIE['select'][$id][$cnt])) // saved parameters 2010-10-06 Joe Hunt
141                                         $_POST['PARAM_'.$cnt] = $_COOKIE['select'][$id][$cnt];
142                                 $ctrl = $this->get_ctrl('PARAM_'.$cnt, $type);
143                         }
144                         if ($ctrl != '')  {
145                                 $st .= $title . ':<br>';
146                                 $st .= $ctrl;
147                                 $st .= "<br><br>";
148                         } else {
149                                 display_error(_('Unknown report parameter type:').$type);
150                         }
151                         $cnt++;
152                 }
153                 return $st;
154         }
155
156         //
157         //      Register additional control handler
158         // $handle - name of global function f($name, $type) returning html code for control
159         function register_controls($handler) {
160                 $this->ctrl_handlers[] = $handler;
161         }
162         //
163         //      Returns html code for input control $name of type $type 
164         //
165         function get_ctrl($name, $type)
166         {
167                 global $path_to_root, $use_date_picker, $pdf_debug, $print_invoice_no,
168                         $def_print_destination, $type_shortcuts;
169
170                 $st = '';
171                         switch ($type)
172                         {
173                                 case 'CURRENCY':
174                                         $sql = "SELECT curr_abrev, concat(curr_abrev,' - ', currency) AS name FROM ".TB_PREF."currencies";
175                                         return combo_input($name, '', $sql, 'curr_abrev', 'name',array('spec_option'=>_("No Currency Filter"),'spec_id'=>ALL_TEXT,'order'=>false));
176
177                                 case 'DATE':
178                                 case 'DATEBEGIN':
179                                 case 'DATEEND':
180                                 case 'DATEBEGINM':
181                                 case 'DATEENDM':
182                                 case 'DATEBEGINTAX':
183                                 case 'DATEENDTAX':
184                                         if (!isset($_POST[$name]))
185                                         {
186                                                 if ($type == 'DATEBEGIN')
187                                                         $date = begin_fiscalyear();
188                                                 elseif ($type == 'DATEEND')
189                                                         $date = end_fiscalyear();
190                                                 else
191                                                         $date = Today();
192                                                 if ($type == 'DATEBEGINM')
193                                                         $date = begin_month($date);
194                                                 elseif ($type == 'DATEENDM')
195                                                         $date = end_month($date);
196                                                 elseif ($type == 'DATEBEGINTAX' || $type == 'DATEENDTAX')
197                                                 {
198                                                         $row = get_company_prefs();
199                                                         $edate = add_months($date, -$row['tax_last']);
200                                                         $edate = end_month($edate);
201                                                         if ($type == 'DATEENDTAX')
202                                                                 $date = $edate;
203                                                         else
204                                                         {
205                                                                 $bdate = begin_month($edate);
206                                                                 $bdate = add_months($bdate, -$row['tax_prd'] + 1);
207                                                                 $date = $bdate;
208                                                         }
209                                                 }
210                                         }
211                                         else // saved parameters 2010-10-16 Joe Hunt
212                                                 $date = $_POST[$name];
213                                         $st = "<input type='text' name='$name' value='$date'>";
214                                         if ($use_date_picker)
215                                                 $st .= "<a href=\"javascript:date_picker(document.forms[0].$name);\">"
216                                                 . "     <img src='$path_to_root/themes/default/images/cal.gif' width='16' height='16' border='0' alt='"._('Click Here to Pick up the date')."'></a>\n";
217                                         return $st;
218                                         break;
219
220                                 case 'YES_NO':
221                                         return yesno_list($name);
222
223                                 case 'PAYMENT_LINK':
224                                         return payment_services($name, null);
225
226                                 case 'DESTINATION':
227                                         $sel = array(_("PDF/Printer"), "Excel");
228                                         $def = 0;
229                                         if (isset($def_print_destination) && $def_print_destination == 1)
230                                                 $def = 1;
231                                         return array_selector($name, $def, $sel);
232
233                                 case 'COMPARE':
234                                         $sel = array(_("Accumulated"), _("Period Y-1"), _("Budget"));
235                                         return array_selector($name, null, $sel);
236
237                                 case 'GRAPHIC':
238                                         $sel = array(_("No Graphics"), _("Vertical bars"), _("Horizontal bars"), 
239                                                                 _("Dots"), _("Lines"), _("Pie"), _("Donut"));
240                                         return array_selector($name, null, $sel);
241
242                                 case 'SYS_TYPES':
243                                         return gl_systypes_list($name, null, _("No Type Filter"));
244
245                                 case 'SYS_TYPES_ALL':
246                                         return systypes_list($name, null, _("No Type Filter"));
247
248                                 case 'TEXT':
249                                         return "<input type='text' name='$name'>";
250
251                                 case 'TEXTBOX':
252                                         $value = (isset($_POST[$name]) ? $_POST[$name] : "");
253                                         return "<textarea rows=4 cols=30 name='$name'>$value</textarea>";
254
255                                 case 'ACCOUNTS': // not used
256                                         return gl_account_types_list($name, null, _("No Account Group Filter"), true);
257
258                                 case 'ACCOUNTS_NO_FILTER': // not used
259                                         return gl_account_types_list($name);
260
261                                 case 'GL_ACCOUNTS':
262                                         return gl_all_accounts_list($name);
263
264                                 case 'BANK_ACCOUNTS':
265                                         return bank_accounts_list($name);
266                                         
267                                 case 'DIMENSION':
268                                         return dimensions_list($name, null, false, ' ', false, true, 0);
269                                         
270                                 case 'DIMENSIONS':
271                                         return dimensions_list($name, null, true, _("No Dimension Filter"), false, true, 0);
272
273                                 case 'DIMENSION1':
274                                         return dimensions_list($name, null, false, ' ', false, true, 1);
275
276                                 case 'DIMENSIONS1':
277                                         return dimensions_list($name, null, true, _("No Dimension Filter"), false, true, 1);
278
279                                 case 'DIMENSION2':
280                                         return dimensions_list($name, null, false, ' ', false, true, 2);
281
282                                 case 'DIMENSIONS2':
283                                         return dimensions_list($name, null, true, _("No Dimension Filter"), false, true, 2);
284
285                                 case 'CUSTOMERS_NO_FILTER':
286                                 case 'CUSTOMERS':
287                                         $sql = "SELECT debtor_no, name FROM ".TB_PREF."debtors_master";
288                                         if ($type == 'CUSTOMERS_NO_FILTER')
289                                                 return customer_list($name, null, _("No Customer Filter"));
290                                         else
291                                                 return customer_list($name);
292
293                                 case 'SUPPLIERS_NO_FILTER':
294                                 case 'SUPPLIERS':
295                                         $sql = "SELECT supplier_id, supp_name FROM ".TB_PREF."suppliers";
296                                         if ($type == 'SUPPLIERS_NO_FILTER')
297                                                 return supplier_list($name, null, _("No Supplier Filter"));
298                                         else
299                                                 return supplier_list($name);
300
301                                 case 'INVOICE':
302                                         $IV = $type_shortcuts[ST_SALESINVOICE];
303                                         $ref = ($print_invoice_no == 1 ? "trans_no" : "reference");
304                                         $sql = "SELECT concat(".TB_PREF."debtor_trans.trans_no, '-',
305                                                 ".TB_PREF."debtor_trans.type) AS TNO, concat('$IV ', ".TB_PREF."debtor_trans.$ref,' ', ".TB_PREF."debtors_master.name) as IName
306                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."debtor_trans WHERE type=".ST_SALESINVOICE." AND ".TB_PREF."debtors_master.debtor_no=".TB_PREF."debtor_trans.debtor_no ORDER BY ".TB_PREF."debtor_trans.trans_no DESC";
307                                         return combo_input($name, '', $sql, 'TNO', 'IName',array('order'=>false));
308
309                                 case 'CREDIT':
310                                         $CN = $type_shortcuts[ST_CUSTCREDIT];
311                                         $ref = ($print_invoice_no == 1 ? "trans_no" : "reference");
312                                         $sql = "SELECT concat(".TB_PREF."debtor_trans.trans_no, '-',
313                                                 ".TB_PREF."debtor_trans.type) AS TNO, concat('$CN ', ".TB_PREF."debtor_trans.$ref,' ', ".TB_PREF."debtors_master.name) as IName
314                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."debtor_trans WHERE type=".ST_CUSTCREDIT." AND ".TB_PREF."debtors_master.debtor_no=".TB_PREF."debtor_trans.debtor_no ORDER BY ".TB_PREF."debtor_trans.trans_no DESC";
315                                         return combo_input($name, '', $sql, 'TNO', 'IName',array('order'=>false));
316
317                                 case 'DELIVERY':
318                                         $DN = $type_shortcuts[ST_CUSTDELIVERY];
319                                         $sql = "SELECT
320                                         concat(".TB_PREF."debtor_trans.trans_no, '-', ".TB_PREF."debtor_trans.type) AS TNO, concat(".TB_PREF."debtor_trans.trans_no, ' $DN ',
321                                          ".TB_PREF."debtors_master.name) as IName
322                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."debtor_trans
323                                                 WHERE type=".ST_CUSTDELIVERY." AND ".TB_PREF."debtors_master.debtor_no=".
324                                                 TB_PREF."debtor_trans.debtor_no ORDER BY ".TB_PREF."debtor_trans.trans_no DESC";
325                                         return combo_input($name, '', $sql, 'TNO', 'IName',array('order'=>false));
326
327                                 case 'ORDERS':
328                                         $ref = ($print_invoice_no == 1 ? "order_no" : "reference");
329                                         $sql = "SELECT ".TB_PREF."sales_orders.order_no, concat(".TB_PREF."sales_orders.$ref, '-',
330                                                 ".TB_PREF."debtors_master.name) as IName
331                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."sales_orders WHERE ".TB_PREF."debtors_master.debtor_no=".TB_PREF."sales_orders.debtor_no 
332                                                 AND ".TB_PREF."sales_orders.trans_type=".ST_SALESORDER." ORDER BY ".TB_PREF."sales_orders.order_no DESC";
333                                         return combo_input($name, '', $sql, 'order_no', 'IName',array('order'=>false));
334
335                                 case 'QUOTATIONS':
336                                         $ref = ($print_invoice_no == 1 ? "order_no" : "reference");
337                                         $sql = "SELECT ".TB_PREF."sales_orders.order_no, concat(".TB_PREF."sales_orders.$ref, '-',
338                                                 ".TB_PREF."debtors_master.name) as IName
339                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."sales_orders WHERE ".TB_PREF."debtors_master.debtor_no=".TB_PREF."sales_orders.debtor_no 
340                                                 AND ".TB_PREF."sales_orders.trans_type=".ST_SALESQUOTE." ORDER BY ".TB_PREF."sales_orders.order_no DESC";
341                                         return combo_input($name, '', $sql, 'order_no', 'IName',array('order'=>false));
342
343                                 case 'PO':
344                                         $ref = ($print_invoice_no == 1 ? "order_no" : "reference");
345                                         $sql = "SELECT ".TB_PREF."purch_orders.order_no, concat(".TB_PREF."purch_orders.$ref, '-',
346                                                 ".TB_PREF."suppliers.supp_name) as IName
347                                                 FROM ".TB_PREF."suppliers, ".TB_PREF."purch_orders WHERE ".TB_PREF."suppliers.supplier_id=".TB_PREF."purch_orders.supplier_id ORDER BY ".TB_PREF."purch_orders.order_no DESC";
348                                         return combo_input($name, '', $sql, 'order_no', 'IName',array('order'=>false));
349
350                                 case 'REMITTANCE':
351                                         $BP = $type_shortcuts[ST_BANKPAYMENT];
352                                         $SP = $type_shortcuts[ST_SUPPAYMENT];
353                                         $CN = $type_shortcuts[ST_SUPPCREDIT];
354                                         $ref = ($print_invoice_no == 1 ? "trans_no" : "reference");
355                                         $sql = "SELECT concat(".TB_PREF."supp_trans.trans_no, '-',
356                                                 ".TB_PREF."supp_trans.type) AS TNO, concat(".TB_PREF."supp_trans.$ref, if (type=".ST_BANKPAYMENT.", ' $BP ', if (type=".ST_SUPPAYMENT.", ' $SP ', ' $CN ')), ".TB_PREF."suppliers.supp_name) as IName
357                                                 FROM ".TB_PREF."suppliers, ".TB_PREF."supp_trans WHERE (type=".ST_BANKPAYMENT." OR type=".ST_SUPPAYMENT." OR type=".ST_SUPPCREDIT.") AND ".TB_PREF."suppliers.supplier_id=".TB_PREF."supp_trans.supplier_id ORDER BY ".TB_PREF."supp_trans.trans_no DESC";
358                                         return combo_input($name, '', $sql, 'TNO', 'IName',array('order'=>false));
359
360                                 case 'RECEIPT':
361                                         $BD = $type_shortcuts[ST_BANKDEPOSIT];
362                                         $CP = $type_shortcuts[ST_CUSTPAYMENT];
363                                         $ref = ($print_invoice_no == 1 ? "trans_no" : "reference");
364                                         $sql = "SELECT concat(".TB_PREF."debtor_trans.trans_no, '-',
365                                                 ".TB_PREF."debtor_trans.type) AS TNO, concat(".TB_PREF."debtor_trans.$ref, if (type=".ST_BANKDEPOSIT.", ' $BD ', ' $CP '), ".TB_PREF."debtors_master.name) as IName
366                                                 FROM ".TB_PREF."debtors_master, ".TB_PREF."debtor_trans WHERE (type=".ST_BANKDEPOSIT." OR type=".ST_CUSTPAYMENT." OR type=".ST_CUSTCREDIT.") AND ".TB_PREF."debtors_master.debtor_no=".TB_PREF."debtor_trans.debtor_no ORDER BY ".TB_PREF."debtor_trans.trans_no DESC";
367                                         return combo_input($name, '', $sql, 'TNO', 'IName',array('order'=>false));
368
369                                 case 'ITEMS':
370                                         return stock_manufactured_items_list($name);
371
372                                 case 'WORKORDER':
373                                         $sql = "SELECT ".TB_PREF."workorders.id, concat(".TB_PREF."workorders.id, '-',
374                                                 ".TB_PREF."stock_master.description) as IName
375                                                 FROM ".TB_PREF."stock_master, ".TB_PREF."workorders WHERE ".TB_PREF."stock_master.stock_id=".TB_PREF."workorders.stock_id ORDER BY ".TB_PREF."workorders.id DESC";
376                                         return combo_input($name, '', $sql, 'id', 'IName',array('order'=>false));
377
378                                 case 'LOCATIONS':
379                                         return  locations_list($name, null, _("No Location Filter"));
380
381                                 case 'CATEGORIES':
382                                         return stock_categories_list($name, null, _("No Category Filter"));
383
384                                 case 'SALESTYPES':
385                                         return sales_types_list($name);
386
387                                 case 'AREAS':
388                                         return sales_areas_list($name);
389
390                                 case 'SALESMEN':
391                                         return sales_persons_list($name, null, _("No Sales Folk Filter"));
392                                         
393                                 case 'TRANS_YEARS':
394                                         return fiscalyears_list($name);
395
396                                 case 'USERS':
397                                         $sql = "SELECT id, user_id FROM ".TB_PREF."users";
398                                         return combo_input($name, '', $sql, 'id', 'user_id',array('spec_option'=>_("No Users Filter"),'spec_id'=>ALL_NUMERIC));
399
400                                 case 'ACCOUNTTAGS':
401                                 case 'DIMENSIONTAGS':
402                                         if ($type == 'ACCOUNTTAGS')
403                                                 $tag_type = TAG_ACCOUNT;
404                                         else
405                                                 $tag_type = TAG_DIMENSION;
406                                         //return tag_list($name, 5, $tag_type, true, false, _("No tags"));
407                                         return tag_list($name, 5, $tag_type, true);
408
409                         }
410                 return '';
411         }
412 }
413
414 class Report
415 {
416         var $id;
417         var $name;
418         var $ar_params;
419         var $controls;
420         
421         function Report($id, $name, $ar_params = null)
422         {
423                 $this->id = $id;
424                 $this->name = $name;
425                 if ($ar_params) $this->set_controls($ar_params);
426         }
427         
428         function set_controls($ar_params) {
429                 $this->controls = $ar_params;
430         }
431         
432         function get_controls() {
433                 return $this->controls;
434         }
435         
436 }
437
438 //------------------------------------------------------------------------------------------------
439 function gl_systypes_list($name, $value=null, $spec_opt=false)
440 {
441         global $systypes_array;
442         
443         $types = $systypes_array;
444         
445         foreach(array(ST_LOCTRANSFER, ST_PURCHORDER, ST_SUPPRECEIVE, ST_MANUISSUE,
446                                 ST_MANURECEIVE, ST_SALESORDER, ST_SALESQUOTE, ST_DIMENSION) as $type)
447                 unset($types[$type]);
448
449         return array_selector($name, $value, $types, 
450                 array( 
451                         'spec_option'=> $spec_opt,
452                         'spec_id' => ALL_NUMERIC,
453                         'async' => false,
454                         )
455         );
456 }
457 /*
458         Add extension/custom reports to report manager.
459 */
460 function add_custom_reports(&$reports)
461 {
462         global $installed_extensions, $path_to_root;
463         
464         // include reports installed inside extension modules
465         if (count($installed_extensions) > 0)
466         {
467                 $extensions = $installed_extensions;
468                 foreach ($extensions as $ext)
469                         if (($ext['active'] && $ext['type'] == 'extension')) {
470                                 $file = $path_to_root.'/'.$ext['path']."/reporting/reports_custom.php";
471                                 if (file_exists($file)) {
472                                         set_ext_domain($ext['path']);
473                                         include_once($file);
474                                         set_ext_domain();
475                                 }
476                         }
477         }
478         $file = company_path()."/reporting/reports_custom.php";
479         if (file_exists($file))
480                 include_once($file);
481 }
482
483 ?>