Some more cleanup and recycling.
[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('ttTeamHelper');
34 import('Period');
35 import('ttProjectHelper');
36 import('ttFavReportHelper');
37 import('ttClientHelper');
38
39 // Access check.
40 if (!ttAccessCheck(right_view_reports)) {
41   header('Location: access_denied.php');
42   exit();
43 }
44
45 // Use custom fields plugin if it is enabled.
46 if ($user->isPluginEnabled('cf')) {
47   require_once('plugins/CustomFields.class.php');
48   $custom_fields = new CustomFields($user->team_id);
49   $smarty->assign('custom_fields', $custom_fields);
50 }
51
52 $form = new Form('reportForm');
53
54 // Get saved favorite reports for user.
55 $report_list = ttFavReportHelper::getReports($user->id);
56 $form->addInput(array('type'=>'combobox',
57   'name'=>'favorite_report',
58   'onchange'=>'document.reportForm.fav_report_changed.value=1;document.reportForm.submit();',
59   'style'=>'width: 250px;',
60   'data'=>$report_list,
61   'datakeys'=>array('id','name'),
62   'empty'=>array('-1'=>$i18n->getKey('dropdown.no'))));
63 $form->addInput(array('type'=>'hidden','name'=>'fav_report_changed'));
64 // Generate and Delete buttons.
65 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->getKey('button.generate')));
66 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->getKey('label.delete'),'onclick'=>"return confirm('".$i18n->getKey('form.reports.confirm_delete')."')"));
67
68 // Dropdown for clients if the clients plugin is enabled.
69 if ($user->isPluginEnabled('cl') && !($user->isClient() && $user->client_id)) {
70   if ($user->canManageTeam() || ($user->isClient() && !$user->client_id))
71     $client_list = ttClientHelper::getClients();
72   else
73     $client_list = ttClientHelper::getClientsForUser();
74   $form->addInput(array('type'=>'combobox',
75     'name'=>'client',
76     'style'=>'width: 250px;',
77     'data'=>$client_list,
78     'datakeys'=>array('id', 'name'),
79     'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
80 }
81
82 // If we have a TYPE_DROPDOWN custom field - add control to select an option.
83 if ($custom_fields && $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
84     $form->addInput(array('type'=>'combobox','name'=>'option',
85       'style'=>'width: 250px;',
86       'value'=>$cl_cf_1,
87       'data'=>$custom_fields->options,
88       'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
89 }
90
91 // Add controls for projects and tasks.
92 if ($user->canManageTeam()) {
93   $project_list = ttProjectHelper::getProjects(); // Manager and co-managers can run reports on all active and inactive projects.
94 } elseif ($user->isClient()) {
95   $project_list = ttProjectHelper::getProjectsForClient();
96 } else {
97   $project_list = ttProjectHelper::getAssignedProjects($user->id);      
98 }
99 $form->addInput(array('type'=>'combobox',
100   'onchange'=>'fillTaskDropdown(this.value);selectAssignedUsers(this.value);',
101   'name'=>'project',
102   'style'=>'width: 250px;',
103   'data'=>$project_list,
104   'datakeys'=>array('id','name'),
105   'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
106 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
107   $task_list = ttTeamHelper::getActiveTasks($user->team_id);
108   $form->addInput(array('type'=>'combobox',
109     'name'=>'task',
110     'style'=>'width: 250px;',
111     'data'=>$task_list,
112     'datakeys'=>array('id','name'),
113     'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
114 }
115
116 // Add include records control.
117 $include_options = array('1'=>$i18n->getKey('form.reports.include_billable'),
118   '2'=>$i18n->getKey('form.reports.include_not_billable'));
119 $form->addInput(array('type'=>'combobox',
120   'name'=>'include_records',
121   'style'=>'width: 250px;',
122   'data'=>$include_options,
123   'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
124
125 if ($user->canManageTeam() && $user->isPluginEnabled('ps')) {
126   $form->addInput(array('type'=>'combobox',
127    'name'=>'paid_status',
128    'style'=>'width: 250px;',
129    'data'=>array('1'=>$i18n->getKey('dropdown.paid'),'2'=>$i18n->getKey('dropdown.not_paid')),
130    'empty'=>array(''=>$i18n->getKey('dropdown.all'))
131  ));
132 }
133
134
135 // Add invoiced / not invoiced selector.
136 $invoice_options = array('1'=>$i18n->getKey('form.reports.include_invoiced'),
137   '2'=>$i18n->getKey('form.reports.include_not_invoiced'));
138 $form->addInput(array('type'=>'combobox',
139   'name'=>'invoice',
140   'style'=>'width: 250px;',
141   'data'=>$invoice_options,
142   'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
143
144 $user_list = array();
145 if ($user->canManageTeam() || $user->isClient()) {
146   // Prepare user and assigned projects arrays.
147   if ($user->canManageTeam())
148     $users = ttTeamHelper::getUsers(); // Active and inactive users for managers.
149   elseif ($user->isClient())
150     $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
151
152   foreach ($users as $single_user) {
153     $user_list[$single_user['id']] = $single_user['name'];
154     $projects = ttProjectHelper::getAssignedProjects($single_user['id']);
155     if ($projects) {
156       foreach ($projects as $single_project) {
157         $assigned_projects[$single_user['id']][] = $single_project['id'];
158       }
159     }
160   }
161   $row_count = ceil(count($user_list)/3);
162   $form->addInput(array('type'=>'checkboxgroup',
163     'name'=>'users',
164     'data'=>$user_list,
165     'layout'=>'V',
166     'groupin'=>$row_count,
167     'style'=>'width: 100%;'));
168 }
169
170 // Add control for time period.
171 $form->addInput(array('type'=>'combobox',
172   'name'=>'period',
173   'style'=>'width: 250px;',
174   'data'=>array(INTERVAL_THIS_MONTH=>$i18n->getKey('dropdown.current_month'),
175     INTERVAL_LAST_MONTH=>$i18n->getKey('dropdown.previous_month'),
176     INTERVAL_THIS_WEEK=>$i18n->getKey('dropdown.current_week'),
177     INTERVAL_LAST_WEEK=>$i18n->getKey('dropdown.previous_week'),
178     INTERVAL_THIS_DAY=>$i18n->getKey('dropdown.current_day'),
179     INTERVAL_LAST_DAY=>$i18n->getKey('dropdown.previous_day')),
180   'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
181 // Add controls for start and end dates.
182 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'start_date'));
183 $form->addInput(array('type'=>'datefield','maxlength'=>'20','name'=>'end_date'));
184
185 // Add checkboxes for fields.
186 if ($user->isPluginEnabled('cl'))
187   $form->addInput(array('type'=>'checkbox','name'=>'chclient'));
188 if (($user->canManageTeam() || $user->isClient()) && $user->isPluginEnabled('iv'))
189   $form->addInput(array('type'=>'checkbox','name'=>'chinvoice'));
190 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
191   $form->addInput(array('type'=>'checkbox','name'=>'chproject'));
192 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
193   $form->addInput(array('type'=>'checkbox','name'=>'chtask'));
194 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
195   $form->addInput(array('type'=>'checkbox','name'=>'chstart'));
196   $form->addInput(array('type'=>'checkbox','name'=>'chfinish'));
197 }
198 $form->addInput(array('type'=>'checkbox','name'=>'chduration'));
199 $form->addInput(array('type'=>'checkbox','name'=>'chnote'));
200 if (defined('COST_ON_REPORTS') && isTrue(COST_ON_REPORTS))
201   $form->addInput(array('type'=>'checkbox','name'=>'chcost'));
202 // If we have a custom field - add a checkbox for it.
203 if ($custom_fields && $custom_fields->fields[0])
204   $form->addInput(array('type'=>'checkbox','name'=>'chcf_1'));
205 if ($user->canManageTeam() && $user->isPluginEnabled('ps'))
206   $form->addInput(array('type'=>'checkbox','name'=>'chpaid'));
207 // Add group by control.
208 $group_by_options['no_grouping'] = $i18n->getKey('form.reports.group_by_no');
209 $group_by_options['date'] = $i18n->getKey('form.reports.group_by_date');
210 if ($user->canManageTeam() || $user->isClient())
211   $group_by_options['user'] = $i18n->getKey('form.reports.group_by_user');
212 if ($user->isPluginEnabled('cl') && !($user->isClient() && $user->client_id))
213   $group_by_options['client'] = $i18n->getKey('form.reports.group_by_client');
214 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
215   $group_by_options['project'] = $i18n->getKey('form.reports.group_by_project');
216 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
217   $group_by_options['task'] = $i18n->getKey('form.reports.group_by_task');
218 if ($custom_fields && $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
219   $group_by_options['cf_1'] = $custom_fields->fields[0]['label'];
220 }
221 $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by','data'=>$group_by_options));
222 $form->addInput(array('type'=>'checkbox','name'=>'chtotalsonly'));
223
224 // Add text field for a new favorite report name.
225 $form->addInput(array('type'=>'text','name'=>'new_fav_report','maxlength'=>'30','style'=>'width: 250px;'));
226 // Save button.
227 $form->addInput(array('type'=>'submit','name'=>'btn_save','value'=>$i18n->getKey('button.save')));
228
229 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->getKey('button.generate')));
230
231 // Create a bean (which is a mechanism to remember form values in session).
232 $bean = new ActionForm('reportBean', $form, $request);
233 // At this point form values are obtained from session if they are there.
234
235 if ($request->isGet() && !$bean->isSaved()) {
236   // No previous form data were found in session. Use the following default values.
237   $form->setValueByElement('users', array_keys($user_list));
238   $period = new Period(INTERVAL_THIS_MONTH, new DateAndTime($user->date_format));
239   $form->setValueByElement('start_date', $period->getStartDate());
240   $form->setValueByElement('end_date', $period->getEndDate());
241   $form->setValueByElement('chclient', '1');
242   $form->setValueByElement('chinvoice', '0');
243   $form->setValueByElement('chproject', '1');
244   $form->setValueByElement('chstart', '1');
245   $form->setValueByElement('chduration', '1');
246   $form->setValueByElement('chcost', '0');
247   $form->setValueByElement('chtask', '1');
248   $form->setValueByElement('chfinish', '1');
249   $form->setValueByElement('chnote', '1');
250   $form->setValueByElement('chcf_1', '0');
251   $form->setValueByElement('chpaid', '0');
252   $form->setValueByElement('chtotalsonly', '0');
253 }
254
255 $form->setValueByElement('fav_report_changed','');
256
257 // Disable the Delete button when no favorite report is selected.
258 if (!$bean->getAttribute('favorite_report') || ($bean->getAttribute('favorite_report') == -1))
259   $form->getElement('btn_delete')->setEnabled(false);
260
261 if ($request->isPost()) {
262   if((!$bean->getAttribute('btn_generate') && ($request->getParameter('fav_report_changed')))) {
263     // User changed favorite report. We need to load new values into the form.
264     if ($bean->getAttribute('favorite_report')) {
265       // This loads new favorite report options into the bean (into our form).
266       ttFavReportHelper::loadReport($user->id, $bean);
267
268       // If user selected no favorite report - mark all user checkboxes (most probable scenario).
269       if ($bean->getAttribute('favorite_report') == -1)
270         $form->setValueByElement('users', array_keys($user_list));
271
272       // Save form data in session for future use.
273       $bean->saveBean();
274       header('Location: reports.php');
275       exit();
276     }
277   } elseif ($bean->getAttribute('btn_save')) {
278     // User clicked the Save button. We need to save form options as new favorite report.
279     if (!ttValidString($bean->getAttribute('new_fav_report'))) $err->add($i18n->getKey('error.field'), $i18n->getKey('form.reports.save_as_favorite'));
280
281     if ($err->no()) {
282       $id = ttFavReportHelper::saveReport($user->id, $bean);
283       if (!$id)
284         $err->add($i18n->getKey('error.db'));
285       if ($err->no()) {
286         $bean->setAttribute('favorite_report', $id);
287         $bean->saveBean();
288         header('Location: reports.php');
289         exit();
290       }
291     }
292   } elseif($bean->getAttribute('btn_delete')) {
293     // Delete button pressed. User wants to delete a favorite report.
294     if ($bean->getAttribute('favorite_report')) {
295       ttFavReportHelper::deleteReport($bean->getAttribute('favorite_report'));
296       // Load default report.
297       $bean->setAttribute('favorite_report','');
298       $bean->setAttribute('new_fav_report', $report_list[0]['name']);
299       ttFavReportHelper::loadReport($user->id, $bean);
300       $form->setValueByElement('users', array_keys($user_list));
301       $bean->saveBean();
302       header('Location: reports.php');
303       exit();
304     }
305   } else {
306     // Generate button pressed. Check some values.
307     if (!$bean->getAttribute('period')) {
308       $start_date = new DateAndTime($user->date_format, $bean->getAttribute('start_date'));
309
310       if ($start_date->isError() || !$bean->getAttribute('start_date'))
311         $err->add($i18n->getKey('error.field'), $i18n->getKey('label.start_date'));
312
313       $end_date = new DateAndTime($user->date_format, $bean->getAttribute('end_date'));
314       if ($end_date->isError() || !$bean->getAttribute('end_date'))
315         $err->add($i18n->getKey('error.field'), $i18n->getKey('label.end_date'));
316
317       if ($start_date->compare($end_date) > 0)
318         $err->add($i18n->getKey('error.interval'), $i18n->getKey('label.end_date'), $i18n->getKey('label.start_date'));
319     }
320
321     $bean->saveBean();
322
323     if ($err->no()) {
324       // Now we can go ahead and create a report.
325       header('Location: report.php');
326       exit();
327     }
328   }
329 } // isPost
330
331 $smarty->assign('project_list', $project_list);
332 $smarty->assign('task_list', $task_list);
333 $smarty->assign('assigned_projects', $assigned_projects);
334 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
335 $smarty->assign('onload', 'onLoad="handleCheckboxes()"');
336 $smarty->assign('title', $i18n->getKey('title.reports'));
337 $smarty->assign('content_page_name', 'reports.tpl');
338 $smarty->display('index.tpl');