Some more work in progress on timesheet reporting.
[timetracker.git] / reports.php
1 <?php
2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
10 // |
11 // | There are only two ways to violate the license:
12 // |
13 // | 1. To redistribute this code in source form, with the copyright
14 // |    notice or license removed or altered. (Distributing in compiled
15 // |    forms without embedded copyright notices is permitted).
16 // |
17 // | 2. To redistribute modified versions of this code in *any* form
18 // |    that bears insufficient indications that the modifications are
19 // |    not the work of the original author(s).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 require_once('initialize.php');
30 import('form.Form');
31 import('form.ActionForm');
32 import('DateAndTime');
33 import('ttGroupHelper');
34 import('Period');
35 import('ttProjectHelper');
36 import('ttFavReportHelper');
37 import('ttClientHelper');
38 import('ttReportHelper');
39
40 // Access check.
41 if (!(ttAccessAllowed('view_own_reports') || ttAccessAllowed('view_reports') || ttAccessAllowed('view_all_reports') || ttAccessAllowed('view_client_reports'))) {
42   header('Location: access_denied.php');
43   exit();
44 }
45 if (!$user->exists()) {
46   header('Location: access_denied.php'); // No users in subgroup.
47   exit();
48 }
49 // End of access checks.
50
51 $trackingMode = $user->getTrackingMode();
52
53 // Use custom fields plugin if it is enabled.
54 if ($user->isPluginEnabled('cf')) {
55   require_once('plugins/CustomFields.class.php');
56   $custom_fields = new CustomFields();
57   $smarty->assign('custom_fields', $custom_fields);
58   $showCustomFieldCheckbox = $custom_fields->fields[0];
59   $showCustomFieldDropdown = $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN;
60   if ($showCustomFieldDropdown)
61     $showCustomFieldDropdown &= count($custom_fields->options) > 0;
62 }
63
64 $form = new Form('reportForm');
65
66 // Get saved favorite reports for user.
67 $report_list = ttFavReportHelper::getReports();
68 $form->addInput(array('type'=>'combobox',
69   'name'=>'favorite_report',
70   'onchange'=>'this.form.fav_report_changed.value=1;this.form.submit();',
71   'style'=>'width: 250px;',
72   'data'=>$report_list,
73   'datakeys'=>array('id','name'),
74   'empty'=>array('-1'=>$i18n->get('dropdown.no'))));
75 $form->addInput(array('type'=>'hidden','name'=>'fav_report_changed'));
76 // Generate and Delete buttons.
77 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->get('button.generate')));
78 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->get('label.delete'),'onclick'=>"return confirm('".$i18n->get('form.reports.confirm_delete')."')"));
79
80 // Dropdown for clients if the clients plugin is enabled.
81 $showClient = $user->isPluginEnabled('cl') && !$user->isClient();
82 if ($showClient) {
83   if ($user->can('view_reports') || $user->can('view_all_reports')) {
84     $client_list = ttClientHelper::getClients(); // TODO: improve getClients for "view_reports"
85                                                  // by filtering out not relevant clients.
86   } else
87     $client_list = ttClientHelper::getClientsForUser();
88   if (count($client_list) == 0) $showClient = false;
89 }
90 if ($showClient) {
91   $form->addInput(array('type'=>'combobox',
92     'name'=>'client',
93     'style'=>'width: 250px;',
94     'data'=>$client_list,
95     'datakeys'=>array('id', 'name'),
96     'empty'=>array(''=>$i18n->get('dropdown.all'))));
97 }
98
99 // If we have a TYPE_DROPDOWN custom field - add a control to select an option.
100 if ($showCustomFieldDropdown) {
101   $form->addInput(array('type'=>'combobox','name'=>'option',
102     'style'=>'width: 250px;',
103     'value'=>$cl_cf_1,
104     'data'=>$custom_fields->options,
105     'empty'=>array(''=>$i18n->get('dropdown.all'))));
106 }
107
108 // Add project dropdown.
109 $showProject = MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode;
110 if ($showProject) {
111   if ($user->can('view_reports') || $user->can('view_all_reports')) {
112     $project_list = ttProjectHelper::getProjects(); // All active and inactive projects.
113   } elseif ($user->isClient()) {
114     $project_list = ttProjectHelper::getProjectsForClient();
115   } else {
116     $project_list = ttProjectHelper::getAssignedProjects($user->getUser());
117   }
118   if (count($project_list) == 0) $showProject = false;
119 }
120 if ($showProject) {
121   $form->addInput(array('type'=>'combobox',
122     'onchange'=>'fillTaskDropdown(this.value);selectAssignedUsers(this.value);',
123     'name'=>'project',
124     'style'=>'width: 250px;',
125     'data'=>$project_list,
126     'datakeys'=>array('id','name'),
127     'empty'=>array(''=>$i18n->get('dropdown.all'))));
128 }
129
130 // Add task dropdown.
131 $showTask = MODE_PROJECTS_AND_TASKS == $trackingMode;
132 if ($showTask) {
133   $task_list = ttGroupHelper::getActiveTasks();
134   if (count($task_list) == 0) $showTask = false;
135 }
136 if ($showTask) {
137   $form->addInput(array('type'=>'combobox',
138     'name'=>'task',
139     'style'=>'width: 250px;',
140     'data'=>$task_list,
141     'datakeys'=>array('id','name'),
142     'empty'=>array(''=>$i18n->get('dropdown.all'))));
143 }
144
145 // Add billable dropdown.
146 $showBillable = $user->isPluginEnabled('iv');
147 if ($showBillable) {
148   $include_options = array('1'=>$i18n->get('form.reports.include_billable'),
149     '2'=>$i18n->get('form.reports.include_not_billable'));
150   $form->addInput(array('type'=>'combobox',
151     'name'=>'include_records', // TODO: how about a better name here?
152     'style'=>'width: 250px;',
153     'data'=>$include_options,
154     'empty'=>array(''=>$i18n->get('dropdown.all'))));
155 }
156
157 // Add invoiced / not invoiced selector.
158 $showInvoiceDropdown = $user->isPluginEnabled('iv') && $user->can('manage_invoices');
159 if ($showInvoiceDropdown) {
160   $invoice_options = array('1'=>$i18n->get('form.reports.include_invoiced'),
161     '2'=>$i18n->get('form.reports.include_not_invoiced'));
162   $form->addInput(array('type'=>'combobox',
163     'name'=>'invoice',
164     'style'=>'width: 250px;',
165     'data'=>$invoice_options,
166     'empty'=>array(''=>$i18n->get('dropdown.all'))));
167 }
168 $showInvoiceCheckbox = $user->isPluginEnabled('iv') && ($user->can('manage_invoices') || $user->isClient());
169
170 // Add paid status selector.
171 $showPaidStatus = $user->isPluginEnabled('ps') && $user->can('manage_invoices');
172 if ($showPaidStatus) {
173   $form->addInput(array('type'=>'combobox',
174    'name'=>'paid_status',
175    'style'=>'width: 250px;',
176    'data'=>array('1'=>$i18n->get('dropdown.paid'),'2'=>$i18n->get('dropdown.not_paid')),
177    'empty'=>array(''=>$i18n->get('dropdown.all'))
178  ));
179 }
180
181 // Add timesheet assignment selector.
182 $showTimesheet = $user->isPluginEnabled('ts') &&
183   ($user->can('view_own_timesheets') || $user->can('view_timesheets') ||
184    $user->can('view_all_timesheets') || $user->can('view_client_timesheets'));
185 if ($showTimesheet) {
186   $form->addInput(array('type'=>'combobox',
187    'name'=>'timesheet',
188    'style'=>'width: 250px;',
189    'data'=>array(TIMESHEET_NOT_ASSIGNED=>$i18n->get('form.reports.include_not_assigned'),
190      TIMESHEET_ASSIGNED=>$i18n->get('form.reports.include_assigned'),
191      TIMESHEET_PENDING=>$i18n->get('form.reports.include_pending'),
192      TIMESHEET_APPROVED=>$i18n->get('form.reports.include_approved'),
193      TIMESHEET_NOT_APPROVED=>$i18n->get('form.reports.include_not_approved')),
194    'empty'=>array(''=>$i18n->get('dropdown.all'))
195   ));
196 }
197
198 // Add user table.
199 $showUsers = $user->can('view_reports') || $user->can('view_all_reports') || $user->isClient();
200 $user_list = array();
201 if ($showUsers) {
202   // Prepare user and assigned projects arrays.
203   if ($user->can('view_reports') || $user->can('view_all_reports')) {
204     $rank = $user->getMaxRankForGroup($user->getGroup());
205     if ($user->can('view_all_reports')) $max_rank = MAX_RANK;
206     if ($user->can('view_own_reports'))
207       $options = array('max_rank'=>$max_rank,'include_self'=>true);
208     else
209       $options = array('max_rank'=>$max_rank);
210     $users = $user->getUsers($options); // Active and inactive users.
211   }
212   elseif ($user->isClient())
213     $users = ttGroupHelper::getUsersForClient(); // Active and inactive users for clients.
214
215   foreach ($users as $single_user) {
216     $user_list[$single_user['id']] = $single_user['name'];
217     $projects = ttProjectHelper::getAssignedProjects($single_user['id']);
218     if ($projects) {
219       foreach ($projects as $single_project) {
220         $assigned_projects[$single_user['id']][] = $single_project['id'];
221       }
222     }
223   }
224   $row_count = ceil(count($user_list)/3);
225   $form->addInput(array('type'=>'checkboxgroup',
226     'name'=>'users',
227     'data'=>$user_list,
228     'layout'=>'V',
229     'groupin'=>$row_count,
230     'style'=>'width: 100%;'));
231 }
232
233 // Add control for time period.
234 $form->addInput(array('type'=>'combobox',
235   'name'=>'period',
236   'style'=>'width: 250px;',
237   'data'=>array(INTERVAL_THIS_MONTH=>$i18n->get('dropdown.current_month'),
238     INTERVAL_LAST_MONTH=>$i18n->get('dropdown.previous_month'),
239     INTERVAL_THIS_WEEK=>$i18n->get('dropdown.current_week'),
240     INTERVAL_LAST_WEEK=>$i18n->get('dropdown.previous_week'),
241     INTERVAL_THIS_DAY=>$i18n->get('dropdown.current_day'),
242     INTERVAL_LAST_DAY=>$i18n->get('dropdown.previous_day')),
243   'empty'=>array(''=>$i18n->get('dropdown.select'))));
244 // Add controls for start and end dates.
245 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'start_date'));
246 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'end_date'));
247
248 // Add checkboxes for "Show fields" block.
249 if ($showClient)
250   $form->addInput(array('type'=>'checkbox','name'=>'chclient'));
251 if ($showProject)
252   $form->addInput(array('type'=>'checkbox','name'=>'chproject'));
253 if ($showTask)
254   $form->addInput(array('type'=>'checkbox','name'=>'chtask'));
255 if ($showCustomFieldCheckbox)
256   $form->addInput(array('type'=>'checkbox','name'=>'chcf_1'));
257 if ($showInvoiceCheckbox)
258   $form->addInput(array('type'=>'checkbox','name'=>'chinvoice'));
259 if ($showPaidStatus)
260   $form->addInput(array('type'=>'checkbox','name'=>'chpaid'));
261 $showIP = $user->can('view_reports') || $user->can('view_all_reports');
262 if ($showIP)
263   $form->addInput(array('type'=>'checkbox','name'=>'chip'));
264 $recordType = $user->getRecordType();
265 $showStart = TYPE_START_FINISH == $recordType || TYPE_ALL == $recordType;
266 $showFinish = $showStart;
267 if ($showStart)
268   $form->addInput(array('type'=>'checkbox','name'=>'chstart'));
269 if ($showFinish)
270   $form->addInput(array('type'=>'checkbox','name'=>'chfinish'));
271 $form->addInput(array('type'=>'checkbox','name'=>'chduration'));
272 $form->addInput(array('type'=>'checkbox','name'=>'chnote'));
273 $form->addInput(array('type'=>'checkbox','name'=>'chcost'));
274 $showWorkUnits = $user->isPluginEnabled('wu');
275 if ($showWorkUnits)
276   $form->addInput(array('type'=>'checkbox','name'=>'chunits'));
277 if ($showTimesheet)
278   $form->addInput(array('type'=>'checkbox','name'=>'chtimesheet'));
279
280 // Add a hidden control for timesheet_user_id (who to generate a timesheet for).
281 if ($showTimesheet)
282   $form->addInput(array('type'=>'hidden','name'=>'timesheet_user_id'));
283
284 // Add group by control.
285 $group_by_options['no_grouping'] = $i18n->get('form.reports.group_by_no');
286 $group_by_options['date'] = $i18n->get('form.reports.group_by_date');
287 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
288   $group_by_options['user'] = $i18n->get('form.reports.group_by_user');
289 if ($user->isPluginEnabled('cl') && !($user->isClient() && $user->client_id))
290   $group_by_options['client'] = $i18n->get('form.reports.group_by_client');
291 if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode)
292   $group_by_options['project'] = $i18n->get('form.reports.group_by_project');
293 if (MODE_PROJECTS_AND_TASKS == $trackingMode)
294   $group_by_options['task'] = $i18n->get('form.reports.group_by_task');
295 if ($custom_fields && $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
296   $group_by_options['cf_1'] = $custom_fields->fields[0]['label'];
297 }
298 $group_by_options_size = sizeof($group_by_options);
299 $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by1','data'=>$group_by_options));
300 if ($group_by_options_size > 2) $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by2','data'=>$group_by_options));
301 if ($group_by_options_size > 3) $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by3','data'=>$group_by_options));
302 $form->addInput(array('type'=>'checkbox','name'=>'chtotalsonly'));
303
304 // Add text field for a new favorite report name.
305 $form->addInput(array('type'=>'text','name'=>'new_fav_report','maxlength'=>'30','style'=>'width: 250px;'));
306 // Save button.
307 $form->addInput(array('type'=>'submit','name'=>'btn_save','value'=>$i18n->get('button.save')));
308
309 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->get('button.generate')));
310
311 // Create a bean (which is a mechanism to remember form values in session).
312 $bean = new ActionForm('reportBean', $form, $request);
313 // At this point form values are obtained from session if they are there.
314
315 if ($request->isGet() && !$bean->isSaved()) {
316   // No previous form data were found in session. Use the following default values.
317   $form->setValueByElement('users', array_keys($user_list));
318   $period = new Period(INTERVAL_THIS_MONTH, new DateAndTime($user->getDateFormat()));
319   $form->setValueByElement('start_date', $period->getStartDate());
320   $form->setValueByElement('end_date', $period->getEndDate());
321   $form->setValueByElement('chclient', '1');
322   $form->setValueByElement('chinvoice', '0');
323   $form->setValueByElement('chpaid', '0');
324   $form->setValueByElement('chip', '0');
325   $form->setValueByElement('chproject', '1');
326   $form->setValueByElement('chstart', '1');
327   $form->setValueByElement('chduration', '1');
328   $form->setValueByElement('chcost', '0');
329   $form->setValueByElement('chtask', '1');
330   $form->setValueByElement('chfinish', '1');
331   $form->setValueByElement('chnote', '1');
332   $form->setValueByElement('chcf_1', '0');
333   $form->setValueByElement('chunits', '0');
334   $form->setValueByElement('chtimesheet', '0');
335   $form->setValueByElement('chtotalsonly', '0');
336 }
337
338 $form->setValueByElement('fav_report_changed','');
339
340 // Disable the Delete button when no favorite report is selected.
341 if (!$bean->getAttribute('favorite_report') || ($bean->getAttribute('favorite_report') == -1))
342   $form->getElement('btn_delete')->setEnabled(false);
343
344 if ($request->isPost()) {
345   if((!$bean->getAttribute('btn_generate') && ($request->getParameter('fav_report_changed')))) {
346     // User changed favorite report. We need to load new values into the form.
347     if ($bean->getAttribute('favorite_report')) {
348       // This loads new favorite report options into the bean (into our form).
349       ttFavReportHelper::loadReport($bean);
350
351       // If user selected no favorite report - mark all user checkboxes (most probable scenario).
352       if ($bean->getAttribute('favorite_report') == -1)
353         $form->setValueByElement('users', array_keys($user_list));
354
355       // Save form data in session for future use.
356       $bean->saveBean();
357       header('Location: reports.php');
358       exit();
359     }
360   } elseif ($bean->getAttribute('btn_save')) {
361     // User clicked the Save button. We need to save form options as new favorite report.
362     if (!ttValidString($bean->getAttribute('new_fav_report'))) $err->add($i18n->get('error.field'), $i18n->get('form.reports.save_as_favorite'));
363
364     if ($err->no()) {
365       $id = ttFavReportHelper::saveReport($bean);
366       if (!$id)
367         $err->add($i18n->get('error.db'));
368       if ($err->no()) {
369         $bean->setAttribute('favorite_report', $id);
370         $bean->saveBean();
371         header('Location: reports.php');
372         exit();
373       }
374     }
375   } elseif($bean->getAttribute('btn_delete')) {
376     // Delete button pressed. User wants to delete a favorite report.
377     if ($bean->getAttribute('favorite_report')) {
378       ttFavReportHelper::deleteReport($bean->getAttribute('favorite_report'));
379       // Load default report.
380       $bean->setAttribute('favorite_report','');
381       $bean->setAttribute('new_fav_report', $report_list[0]['name']);
382       ttFavReportHelper::loadReport($bean);
383       $form->setValueByElement('users', array_keys($user_list));
384       $bean->saveBean();
385       header('Location: reports.php');
386       exit();
387     }
388   } else {
389     // Generate button pressed. Check some values.
390     if (!$bean->getAttribute('period')) {
391       $start_date = new DateAndTime($user->getDateFormat(), $bean->getAttribute('start_date'));
392
393       if ($start_date->isError() || !$bean->getAttribute('start_date'))
394         $err->add($i18n->get('error.field'), $i18n->get('label.start_date'));
395
396       $end_date = new DateAndTime($user->getDateFormat(), $bean->getAttribute('end_date'));
397       if ($end_date->isError() || !$bean->getAttribute('end_date'))
398         $err->add($i18n->get('error.field'), $i18n->get('label.end_date'));
399
400       if ($start_date->compare($end_date) > 0)
401         $err->add($i18n->get('error.interval'), $i18n->get('label.end_date'), $i18n->get('label.start_date'));
402     }
403     $group_by1 = $bean->getAttribute('group_by1');
404     $group_by2 = $bean->getAttribute('group_by2');
405     $group_by3 = $bean->getAttribute('group_by3');
406     if (($group_by3 != null && $group_by3 != 'no_grouping') && ($group_by3 == $group_by1 || $group_by3 == $group_by2))
407       $err->add($i18n->get('error.field'), $i18n->get('form.reports.group_by'));
408     if (($group_by2 != null && $group_by2 != 'no_grouping') && ($group_by2 == $group_by1 || $group_by3 == $group_by2))
409       $err->add($i18n->get('error.field'), $i18n->get('form.reports.group_by'));
410     // Check remaining values.
411     if (!ttReportHelper::verifyBean($bean)) $err->add($i18n->get('error.sys'));
412
413     if ($err->no()) {
414       $bean->saveBean();
415       // Now we can go ahead and create a report.
416       header('Location: report.php');
417       exit();
418     }
419   }
420 } // isPost
421
422 $smarty->assign('show_client', $showClient);
423 $smarty->assign('show_cf_1_dropdown', $showCustomFieldDropdown);
424 $smarty->assign('show_cf_1_checkbox', $showCustomFieldCheckbox);
425 $smarty->assign('show_project', $showProject);
426 $smarty->assign('show_task', $showTask);
427 $smarty->assign('show_billable', $showBillable);
428 $smarty->assign('show_invoice_dropdown', $showInvoiceDropdown);
429 $smarty->assign('show_invoice_checkbox', $showInvoiceCheckbox);
430 $smarty->assign('show_paid_status', $showPaidStatus);
431 $smarty->assign('show_timesheet', $showTimesheet);
432 $smarty->assign('show_users', $showUsers);
433 $smarty->assign('show_start', $showStart);
434 $smarty->assign('show_finish', $showFinish);
435 $smarty->assign('show_work_units', $showWorkUnits);
436 $smarty->assign('show_ip', $showIP);
437 $smarty->assign('project_list', $project_list);
438 $smarty->assign('task_list', $task_list);
439 $smarty->assign('assigned_projects', $assigned_projects);
440 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
441 $smarty->assign('onload', 'onLoad="handleCheckboxes()"');
442 $smarty->assign('title', $i18n->get('title.reports'));
443 $smarty->assign('content_page_name', 'reports.tpl');
444 $smarty->display('index.tpl');