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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 require_once('initialize.php');
31 import('form.ActionForm');
32 import('DateAndTime');
33 import('ttGroupHelper');
35 import('ttProjectHelper');
36 import('ttFavReportHelper');
37 import('ttClientHelper');
38 import('ttReportHelper');
41 if (!(ttAccessAllowed('view_own_reports') || ttAccessAllowed('view_reports') || ttAccessAllowed('view_all_reports') || ttAccessAllowed('view_client_reports'))) {
42 header('Location: access_denied.php');
45 if (!$user->exists()) {
46 header('Location: access_denied.php'); // No users in subgroup.
49 // End of access checks.
51 $trackingMode = $user->getTrackingMode();
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;
64 $form = new Form('reportForm');
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;',
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')."')"));
80 // Dropdown for clients if the clients plugin is enabled.
81 $showClient = $user->isPluginEnabled('cl') && !$user->isClient();
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.
87 $client_list = ttClientHelper::getClientsForUser();
88 if (count($client_list) == 0) $showClient = false;
91 $form->addInput(array('type'=>'combobox',
93 'style'=>'width: 250px;',
95 'datakeys'=>array('id', 'name'),
96 'empty'=>array(''=>$i18n->get('dropdown.all'))));
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;',
104 'data'=>$custom_fields->options,
105 'empty'=>array(''=>$i18n->get('dropdown.all'))));
108 // Add project dropdown.
109 $showProject = MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode;
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();
116 $project_list = ttProjectHelper::getAssignedProjects($user->getUser());
118 if (count($project_list) == 0) $showProject = false;
121 $form->addInput(array('type'=>'combobox',
122 'onchange'=>'fillTaskDropdown(this.value);selectAssignedUsers(this.value);',
124 'style'=>'width: 250px;',
125 'data'=>$project_list,
126 'datakeys'=>array('id','name'),
127 'empty'=>array(''=>$i18n->get('dropdown.all'))));
130 // Add task dropdown.
131 $showTask = MODE_PROJECTS_AND_TASKS == $trackingMode;
133 $task_list = ttGroupHelper::getActiveTasks();
134 if (count($task_list) == 0) $showTask = false;
137 $form->addInput(array('type'=>'combobox',
139 'style'=>'width: 250px;',
141 'datakeys'=>array('id','name'),
142 'empty'=>array(''=>$i18n->get('dropdown.all'))));
145 // Add billable dropdown.
146 $showBillable = $user->isPluginEnabled('iv');
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'))));
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',
164 'style'=>'width: 250px;',
165 'data'=>$invoice_options,
166 'empty'=>array(''=>$i18n->get('dropdown.all'))));
168 $showInvoiceCheckbox = $user->isPluginEnabled('iv') && ($user->can('manage_invoices') || $user->isClient());
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'))
181 // Add approved / not approved selector.
182 $showApproved = $user->isPluginEnabled('ap') &&
183 ($user->can('view_own_reports') || $user->can('view_reports') ||
184 $user->can('view_all_reports') || ($user->can('view_client_reports') && $user->can('view_client_unapproved')));
186 $form->addInput(array('type'=>'combobox',
188 'style'=>'width: 250px;',
189 'data'=>array('1'=>$i18n->get('dropdown.approved'),'2'=>$i18n->get('dropdown.not_approved')),
190 'empty'=>array(''=>$i18n->get('dropdown.all'))
194 // Add timesheet assignment selector.
195 $showTimesheetDropdown = $user->isPluginEnabled('ts') &&
196 ($user->can('view_own_timesheets') || $user->can('view_timesheets') ||
197 $user->can('view_all_timesheets') || ($user->can('view_client_timesheets')));
198 if ($showTimesheetDropdown) {
199 $form->addInput(array('type'=>'combobox',
201 'style'=>'width: 250px;',
202 'data'=>array(TIMESHEET_NOT_ASSIGNED=>$i18n->get('form.reports.include_not_assigned'),
203 TIMESHEET_ASSIGNED=>$i18n->get('form.reports.include_assigned'),
204 TIMESHEET_PENDING=>$i18n->get('form.reports.include_pending'),
205 TIMESHEET_APPROVED=>$i18n->get('dropdown.approved'),
206 TIMESHEET_NOT_APPROVED=>$i18n->get('dropdown.not_approved')),
207 'empty'=>array(''=>$i18n->get('dropdown.all'))
210 $showTimesheetCheckbox = $user->isPluginEnabled('ts') &&
211 ($user->can('view_own_timesheets') || $user->can('view_timesheets') ||
212 $user->can('view_all_timesheets') || $user->can('view_client_timesheets'));
215 $showUsers = $user->can('view_reports') || $user->can('view_all_reports') || $user->isClient();
216 $user_list = array();
218 // Prepare user and assigned projects arrays.
219 if ($user->can('view_reports') || $user->can('view_all_reports')) {
220 $rank = $user->getMaxRankForGroup($user->getGroup());
221 if ($user->can('view_all_reports')) $max_rank = MAX_RANK;
222 if ($user->can('view_own_reports'))
223 $options = array('max_rank'=>$max_rank,'include_self'=>true);
225 $options = array('max_rank'=>$max_rank);
226 $users = $user->getUsers($options); // Active and inactive users.
228 elseif ($user->isClient())
229 $users = ttGroupHelper::getUsersForClient(); // Active and inactive users for clients.
231 foreach ($users as $single_user) {
232 $user_list[$single_user['id']] = $single_user['name'];
233 $projects = ttProjectHelper::getAssignedProjects($single_user['id']);
235 foreach ($projects as $single_project) {
236 $assigned_projects[$single_user['id']][] = $single_project['id'];
240 $row_count = ceil(count($user_list)/3);
241 $form->addInput(array('type'=>'checkboxgroup',
245 'groupin'=>$row_count,
246 'style'=>'width: 100%;'));
249 // Add control for time period.
250 $form->addInput(array('type'=>'combobox',
252 'style'=>'width: 250px;',
253 'data'=>array(INTERVAL_THIS_MONTH=>$i18n->get('dropdown.current_month'),
254 INTERVAL_LAST_MONTH=>$i18n->get('dropdown.previous_month'),
255 INTERVAL_THIS_WEEK=>$i18n->get('dropdown.current_week'),
256 INTERVAL_LAST_WEEK=>$i18n->get('dropdown.previous_week'),
257 INTERVAL_THIS_DAY=>$i18n->get('dropdown.current_day'),
258 INTERVAL_LAST_DAY=>$i18n->get('dropdown.previous_day')),
259 'empty'=>array(''=>$i18n->get('dropdown.select'))));
260 // Add controls for start and end dates.
261 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'start_date'));
262 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'end_date'));
264 // Add checkboxes for "Show fields" block.
266 $form->addInput(array('type'=>'checkbox','name'=>'chclient'));
268 $form->addInput(array('type'=>'checkbox','name'=>'chproject'));
270 $form->addInput(array('type'=>'checkbox','name'=>'chtask'));
271 if ($showCustomFieldCheckbox)
272 $form->addInput(array('type'=>'checkbox','name'=>'chcf_1'));
273 if ($showInvoiceCheckbox)
274 $form->addInput(array('type'=>'checkbox','name'=>'chinvoice'));
276 $form->addInput(array('type'=>'checkbox','name'=>'chpaid'));
277 $showIP = $user->can('view_reports') || $user->can('view_all_reports');
279 $form->addInput(array('type'=>'checkbox','name'=>'chip'));
280 $recordType = $user->getRecordType();
281 $showStart = TYPE_START_FINISH == $recordType || TYPE_ALL == $recordType;
282 $showFinish = $showStart;
284 $form->addInput(array('type'=>'checkbox','name'=>'chstart'));
286 $form->addInput(array('type'=>'checkbox','name'=>'chfinish'));
287 $form->addInput(array('type'=>'checkbox','name'=>'chduration'));
288 $form->addInput(array('type'=>'checkbox','name'=>'chnote'));
289 $form->addInput(array('type'=>'checkbox','name'=>'chcost'));
290 $showWorkUnits = $user->isPluginEnabled('wu');
292 $form->addInput(array('type'=>'checkbox','name'=>'chunits'));
293 if ($showTimesheetCheckbox)
294 $form->addInput(array('type'=>'checkbox','name'=>'chtimesheet'));
296 $form->addInput(array('type'=>'checkbox','name'=>'chapproved'));
298 // Add a hidden control for timesheet_user_id (who to generate a timesheet for).
299 if ($showTimesheetCheckbox)
300 $form->addInput(array('type'=>'hidden','name'=>'timesheet_user_id'));
302 // Add group by control.
303 $group_by_options['no_grouping'] = $i18n->get('form.reports.group_by_no');
304 $group_by_options['date'] = $i18n->get('form.reports.group_by_date');
305 if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
306 $group_by_options['user'] = $i18n->get('form.reports.group_by_user');
307 if ($user->isPluginEnabled('cl') && !($user->isClient() && $user->client_id))
308 $group_by_options['client'] = $i18n->get('form.reports.group_by_client');
309 if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode)
310 $group_by_options['project'] = $i18n->get('form.reports.group_by_project');
311 if (MODE_PROJECTS_AND_TASKS == $trackingMode)
312 $group_by_options['task'] = $i18n->get('form.reports.group_by_task');
313 if ($custom_fields && $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
314 $group_by_options['cf_1'] = $custom_fields->fields[0]['label'];
316 $group_by_options_size = sizeof($group_by_options);
317 $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by1','data'=>$group_by_options));
318 if ($group_by_options_size > 2) $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by2','data'=>$group_by_options));
319 if ($group_by_options_size > 3) $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by3','data'=>$group_by_options));
320 $form->addInput(array('type'=>'checkbox','name'=>'chtotalsonly'));
322 // Add text field for a new favorite report name.
323 $form->addInput(array('type'=>'text','name'=>'new_fav_report','maxlength'=>'30','style'=>'width: 250px;'));
325 $form->addInput(array('type'=>'submit','name'=>'btn_save','value'=>$i18n->get('button.save')));
327 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->get('button.generate')));
329 // Create a bean (which is a mechanism to remember form values in session).
330 $bean = new ActionForm('reportBean', $form, $request);
331 // At this point form values are obtained from session if they are there.
333 if ($request->isGet() && !$bean->isSaved()) {
334 // No previous form data were found in session. Use the following default values.
335 $form->setValueByElement('users', array_keys($user_list));
336 $period = new Period(INTERVAL_THIS_MONTH, new DateAndTime($user->getDateFormat()));
337 $form->setValueByElement('start_date', $period->getStartDate());
338 $form->setValueByElement('end_date', $period->getEndDate());
340 $form->setValueByElement('chclient', '1');
341 $form->setValueByElement('chstart', '1');
342 $form->setValueByElement('chfinish', '1');
343 $form->setValueByElement('chduration', '1');
345 $form->setValueByElement('chproject', '1');
346 $form->setValueByElement('chtask', '1');
347 $form->setValueByElement('chnote', '1');
348 $form->setValueByElement('chcost', '0');
350 $form->setValueByElement('chtimesheet', '0');
351 $form->setValueByElement('chip', '0');
352 $form->setValueByElement('chapproved', '0');
353 $form->setValueByElement('chpaid', '0');
355 $form->setValueByElement('chcf_1', '0');
356 $form->setValueByElement('chunits', '0');
357 $form->setValueByElement('chinvoice', '0');
359 $form->setValueByElement('chtotalsonly', '0');
362 $form->setValueByElement('fav_report_changed','');
364 // Disable the Delete button when no favorite report is selected.
365 if (!$bean->getAttribute('favorite_report') || ($bean->getAttribute('favorite_report') == -1))
366 $form->getElement('btn_delete')->setEnabled(false);
368 if ($request->isPost()) {
369 if((!$bean->getAttribute('btn_generate') && ($request->getParameter('fav_report_changed')))) {
370 // User changed favorite report. We need to load new values into the form.
371 if ($bean->getAttribute('favorite_report')) {
372 // This loads new favorite report options into the bean (into our form).
373 ttFavReportHelper::loadReport($bean);
375 // If user selected no favorite report - mark all user checkboxes (most probable scenario).
376 if ($bean->getAttribute('favorite_report') == -1)
377 $form->setValueByElement('users', array_keys($user_list));
379 // Save form data in session for future use.
381 header('Location: reports.php');
384 } elseif ($bean->getAttribute('btn_save')) {
385 // User clicked the Save button. We need to save form options as new favorite report.
386 if (!ttValidString($bean->getAttribute('new_fav_report'))) $err->add($i18n->get('error.field'), $i18n->get('form.reports.save_as_favorite'));
389 $id = ttFavReportHelper::saveReport($bean);
391 $err->add($i18n->get('error.db'));
393 $bean->setAttribute('favorite_report', $id);
395 header('Location: reports.php');
399 } elseif($bean->getAttribute('btn_delete')) {
400 // Delete button pressed. User wants to delete a favorite report.
401 if ($bean->getAttribute('favorite_report')) {
402 ttFavReportHelper::deleteReport($bean->getAttribute('favorite_report'));
403 // Load default report.
404 $bean->setAttribute('favorite_report','');
405 $bean->setAttribute('new_fav_report', $report_list[0]['name']);
406 ttFavReportHelper::loadReport($bean);
407 $form->setValueByElement('users', array_keys($user_list));
409 header('Location: reports.php');
413 // Generate button pressed. Check some values.
414 if (!$bean->getAttribute('period')) {
415 $start_date = new DateAndTime($user->getDateFormat(), $bean->getAttribute('start_date'));
417 if ($start_date->isError() || !$bean->getAttribute('start_date'))
418 $err->add($i18n->get('error.field'), $i18n->get('label.start_date'));
420 $end_date = new DateAndTime($user->getDateFormat(), $bean->getAttribute('end_date'));
421 if ($end_date->isError() || !$bean->getAttribute('end_date'))
422 $err->add($i18n->get('error.field'), $i18n->get('label.end_date'));
424 if ($start_date->compare($end_date) > 0)
425 $err->add($i18n->get('error.interval'), $i18n->get('label.end_date'), $i18n->get('label.start_date'));
427 $group_by1 = $bean->getAttribute('group_by1');
428 $group_by2 = $bean->getAttribute('group_by2');
429 $group_by3 = $bean->getAttribute('group_by3');
430 if (($group_by3 != null && $group_by3 != 'no_grouping') && ($group_by3 == $group_by1 || $group_by3 == $group_by2))
431 $err->add($i18n->get('error.field'), $i18n->get('form.reports.group_by'));
432 if (($group_by2 != null && $group_by2 != 'no_grouping') && ($group_by2 == $group_by1 || $group_by3 == $group_by2))
433 $err->add($i18n->get('error.field'), $i18n->get('form.reports.group_by'));
434 // Check remaining values.
435 if (!ttReportHelper::verifyBean($bean)) $err->add($i18n->get('error.sys'));
439 // Now we can go ahead and create a report.
440 header('Location: report.php');
446 $smarty->assign('show_client', $showClient);
447 $smarty->assign('show_cf_1_dropdown', $showCustomFieldDropdown);
448 $smarty->assign('show_cf_1_checkbox', $showCustomFieldCheckbox);
449 $smarty->assign('show_project', $showProject);
450 $smarty->assign('show_task', $showTask);
451 $smarty->assign('show_billable', $showBillable);
452 $smarty->assign('show_approved', $showApproved);
453 $smarty->assign('show_invoice_dropdown', $showInvoiceDropdown);
454 $smarty->assign('show_invoice_checkbox', $showInvoiceCheckbox);
455 $smarty->assign('show_paid_status', $showPaidStatus);
456 $smarty->assign('show_timesheet_dropdown', $showTimesheetDropdown);
457 $smarty->assign('show_timesheet_checkbox', $showTimesheetCheckbox);
458 $smarty->assign('show_users', $showUsers);
459 $smarty->assign('show_start', $showStart);
460 $smarty->assign('show_finish', $showFinish);
461 $smarty->assign('show_work_units', $showWorkUnits);
462 $smarty->assign('show_ip', $showIP);
463 $smarty->assign('project_list', $project_list);
464 $smarty->assign('task_list', $task_list);
465 $smarty->assign('assigned_projects', $assigned_projects);
466 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
467 $smarty->assign('onload', 'onLoad="handleCheckboxes()"');
468 $smarty->assign('title', $i18n->get('title.reports'));
469 $smarty->assign('content_page_name', 'reports.tpl');
470 $smarty->display('index.tpl');