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