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('ttTeamHelper');
35 import('ttProjectHelper');
36 import('ttFavReportHelper');
37 import('ttClientHelper');
40 if (!ttAccessCheck(right_view_reports)) {
41 header('Location: access_denied.php');
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);
52 $form = new Form('reportForm');
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;',
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')."')"));
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();
73 $client_list = ttClientHelper::getClientsForUser();
74 $form->addInput(array('type'=>'combobox',
76 'style'=>'width: 250px;',
78 'datakeys'=>array('id', 'name'),
79 'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
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;',
87 'data'=>$custom_fields->options,
88 'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
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();
97 $project_list = ttProjectHelper::getAssignedProjects($user->id);
99 $form->addInput(array('type'=>'combobox',
100 'onchange'=>'fillTaskDropdown(this.value);selectAssignedUsers(this.value);',
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',
110 'style'=>'width: 250px;',
112 'datakeys'=>array('id','name'),
113 'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
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'))));
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'))
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',
140 'style'=>'width: 250px;',
141 'data'=>$invoice_options,
142 'empty'=>array(''=>$i18n->getKey('dropdown.all'))));
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.
152 foreach ($users as $single_user) {
153 $user_list[$single_user['id']] = $single_user['name'];
154 $projects = ttProjectHelper::getAssignedProjects($single_user['id']);
156 foreach ($projects as $single_project) {
157 $assigned_projects[$single_user['id']][] = $single_project['id'];
161 $row_count = ceil(count($user_list)/3);
162 $form->addInput(array('type'=>'checkboxgroup',
166 'groupin'=>$row_count,
167 'style'=>'width: 100%;'));
170 // Add control for time period.
171 $form->addInput(array('type'=>'combobox',
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'));
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'));
198 $form->addInput(array('type'=>'checkbox','name'=>'chduration'));
199 $form->addInput(array('type'=>'checkbox','name'=>'chnote'));
200 $form->addInput(array('type'=>'checkbox','name'=>'chcost'));
201 // If we have a custom field - add a checkbox for it.
202 if ($custom_fields && $custom_fields->fields[0])
203 $form->addInput(array('type'=>'checkbox','name'=>'chcf_1'));
204 if ($user->canManageTeam() && $user->isPluginEnabled('ps'))
205 $form->addInput(array('type'=>'checkbox','name'=>'chpaid'));
206 // Add group by control.
207 $group_by_options['no_grouping'] = $i18n->getKey('form.reports.group_by_no');
208 $group_by_options['date'] = $i18n->getKey('form.reports.group_by_date');
209 if ($user->canManageTeam() || $user->isClient())
210 $group_by_options['user'] = $i18n->getKey('form.reports.group_by_user');
211 if ($user->isPluginEnabled('cl') && !($user->isClient() && $user->client_id))
212 $group_by_options['client'] = $i18n->getKey('form.reports.group_by_client');
213 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
214 $group_by_options['project'] = $i18n->getKey('form.reports.group_by_project');
215 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
216 $group_by_options['task'] = $i18n->getKey('form.reports.group_by_task');
217 if ($custom_fields && $custom_fields->fields[0] && $custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
218 $group_by_options['cf_1'] = $custom_fields->fields[0]['label'];
220 $form->addInput(array('type'=>'combobox','onchange'=>'handleCheckboxes();','name'=>'group_by','data'=>$group_by_options));
221 $form->addInput(array('type'=>'checkbox','name'=>'chtotalsonly'));
223 // Add text field for a new favorite report name.
224 $form->addInput(array('type'=>'text','name'=>'new_fav_report','maxlength'=>'30','style'=>'width: 250px;'));
226 $form->addInput(array('type'=>'submit','name'=>'btn_save','value'=>$i18n->getKey('button.save')));
228 $form->addInput(array('type'=>'submit','name'=>'btn_generate','value'=>$i18n->getKey('button.generate')));
230 // Create a bean (which is a mechanism to remember form values in session).
231 $bean = new ActionForm('reportBean', $form, $request);
232 // At this point form values are obtained from session if they are there.
234 if ($request->isGet() && !$bean->isSaved()) {
235 // No previous form data were found in session. Use the following default values.
236 $form->setValueByElement('users', array_keys($user_list));
237 $period = new Period(INTERVAL_THIS_MONTH, new DateAndTime($user->date_format));
238 $form->setValueByElement('start_date', $period->getStartDate());
239 $form->setValueByElement('end_date', $period->getEndDate());
240 $form->setValueByElement('chclient', '1');
241 $form->setValueByElement('chinvoice', '0');
242 $form->setValueByElement('chproject', '1');
243 $form->setValueByElement('chstart', '1');
244 $form->setValueByElement('chduration', '1');
245 $form->setValueByElement('chcost', '0');
246 $form->setValueByElement('chtask', '1');
247 $form->setValueByElement('chfinish', '1');
248 $form->setValueByElement('chnote', '1');
249 $form->setValueByElement('chcf_1', '0');
250 $form->setValueByElement('chpaid', '0');
251 $form->setValueByElement('chtotalsonly', '0');
254 $form->setValueByElement('fav_report_changed','');
256 // Disable the Delete button when no favorite report is selected.
257 if (!$bean->getAttribute('favorite_report') || ($bean->getAttribute('favorite_report') == -1))
258 $form->getElement('btn_delete')->setEnabled(false);
260 if ($request->isPost()) {
261 if((!$bean->getAttribute('btn_generate') && ($request->getParameter('fav_report_changed')))) {
262 // User changed favorite report. We need to load new values into the form.
263 if ($bean->getAttribute('favorite_report')) {
264 // This loads new favorite report options into the bean (into our form).
265 ttFavReportHelper::loadReport($user->id, $bean);
267 // If user selected no favorite report - mark all user checkboxes (most probable scenario).
268 if ($bean->getAttribute('favorite_report') == -1)
269 $form->setValueByElement('users', array_keys($user_list));
271 // Save form data in session for future use.
273 header('Location: reports.php');
276 } elseif ($bean->getAttribute('btn_save')) {
277 // User clicked the Save button. We need to save form options as new favorite report.
278 if (!ttValidString($bean->getAttribute('new_fav_report'))) $err->add($i18n->getKey('error.field'), $i18n->getKey('form.reports.save_as_favorite'));
281 $id = ttFavReportHelper::saveReport($user->id, $bean);
283 $err->add($i18n->getKey('error.db'));
285 $bean->setAttribute('favorite_report', $id);
287 header('Location: reports.php');
291 } elseif($bean->getAttribute('btn_delete')) {
292 // Delete button pressed. User wants to delete a favorite report.
293 if ($bean->getAttribute('favorite_report')) {
294 ttFavReportHelper::deleteReport($bean->getAttribute('favorite_report'));
295 // Load default report.
296 $bean->setAttribute('favorite_report','');
297 $bean->setAttribute('new_fav_report', $report_list[0]['name']);
298 ttFavReportHelper::loadReport($user->id, $bean);
299 $form->setValueByElement('users', array_keys($user_list));
301 header('Location: reports.php');
305 // Generate button pressed. Check some values.
306 if (!$bean->getAttribute('period')) {
307 $start_date = new DateAndTime($user->date_format, $bean->getAttribute('start_date'));
309 if ($start_date->isError() || !$bean->getAttribute('start_date'))
310 $err->add($i18n->getKey('error.field'), $i18n->getKey('label.start_date'));
312 $end_date = new DateAndTime($user->date_format, $bean->getAttribute('end_date'));
313 if ($end_date->isError() || !$bean->getAttribute('end_date'))
314 $err->add($i18n->getKey('error.field'), $i18n->getKey('label.end_date'));
316 if ($start_date->compare($end_date) > 0)
317 $err->add($i18n->getKey('error.interval'), $i18n->getKey('label.end_date'), $i18n->getKey('label.start_date'));
323 // Now we can go ahead and create a report.
324 header('Location: report.php');
330 $smarty->assign('project_list', $project_list);
331 $smarty->assign('task_list', $task_list);
332 $smarty->assign('assigned_projects', $assigned_projects);
333 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
334 $smarty->assign('onload', 'onLoad="handleCheckboxes()"');
335 $smarty->assign('title', $i18n->getKey('title.reports'));
336 $smarty->assign('content_page_name', 'reports.tpl');
337 $smarty->display('index.tpl');