Some optimization related to confirm save feature.
[timetracker.git] / expense_edit.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('ttTeamHelper');
32 import('DateAndTime');
33 import('ttExpenseHelper');
34
35 // Access checks.
36 if (!(ttAccessAllowed('track_own_expenses') || ttAccessAllowed('track_expenses'))) {
37   header('Location: access_denied.php');
38   exit();
39 }
40 if (!$user->isPluginEnabled('ex')) {
41   header('Location: feature_disabled.php');
42   exit();
43 }
44 $cl_id = (int)$request->getParameter('id');
45 // Get the expense item we are editing.
46 $expense_item = ttExpenseHelper::getItem($cl_id, $user->getUser());
47 if (!$expense_item || $expense_item['invoice_id']) {
48   // Prohibit editing not ours or invoiced items.
49   header('Location: access_denied.php');
50   exit();
51 }
52
53 $item_date = new DateAndTime(DB_DATEFORMAT, $expense_item['date']);
54 $confirm_save = $user->getConfigOption('confirm_save');
55
56 // Initialize variables.
57 $cl_date = $cl_client = $cl_project = $cl_item_name = $cl_cost = null;
58 if ($request->isPost()) {
59   $cl_date = trim($request->getParameter('date'));
60   $cl_client = $request->getParameter('client');
61   $cl_project = $request->getParameter('project');
62   $cl_item_name = trim($request->getParameter('item_name'));
63   $cl_cost = trim($request->getParameter('cost'));
64   if ($user->isPluginEnabled('ps'))
65     $cl_paid = $request->getParameter('paid');
66 } else {
67   $cl_date = $item_date->toString($user->date_format);
68   $cl_client = $expense_item['client_id'];
69   $cl_project = $expense_item['project_id'];
70   $cl_item_name = $expense_item['name'];
71   $cl_cost = $expense_item['cost'];
72   $cl_paid = $expense_item['paid'];
73 }
74
75 // Initialize elements of 'expenseItemForm'.
76 $form = new Form('expenseItemForm');
77
78 // Dropdown for clients in MODE_TIME. Use all active clients.
79 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
80   $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
81   $form->addInput(array('type'=>'combobox',
82     'onchange'=>'fillProjectDropdown(this.value);',
83     'name'=>'client',
84     'style'=>'width: 250px;',
85     'value'=>$cl_client,
86     'data'=>$active_clients,
87     'datakeys'=>array('id', 'name'),
88     'empty'=>array(''=>$i18n->get('dropdown.select'))));
89   // Note: in other modes the client list is filtered to relevant clients only. See below.
90 }
91
92 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
93   // Dropdown for projects assigned to user.
94   $project_list = $user->getAssignedProjects();
95   $form->addInput(array('type'=>'combobox',
96     'name'=>'project',
97     'style'=>'width: 250px;',
98     'value'=>$cl_project,
99     'data'=>$project_list,
100     'datakeys'=>array('id','name'),
101     'empty'=>array(''=>$i18n->get('dropdown.select'))));
102
103   // Dropdown for clients if the clients plugin is enabled.
104   if ($user->isPluginEnabled('cl')) {
105     $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
106     // We need an array of assigned project ids to do some trimming. 
107     foreach($project_list as $project)
108       $projects_assigned_to_user[] = $project['id'];
109
110     // Build a client list out of active clients. Use only clients that are relevant to user.
111     // Also trim their associated project list to only assigned projects (to user).
112     foreach($active_clients as $client) {
113       $projects_assigned_to_client = explode(',', $client['projects']);
114       $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
115       if ($intersection) {
116         $client['projects'] = implode(',', $intersection);
117         $client_list[] = $client;
118       }
119     }
120     $form->addInput(array('type'=>'combobox',
121       'onchange'=>'fillProjectDropdown(this.value);',
122       'name'=>'client',
123       'style'=>'width: 250px;',
124       'value'=>$cl_client,
125       'data'=>$client_list,
126       'datakeys'=>array('id', 'name'),
127       'empty'=>array(''=>$i18n->get('dropdown.select'))));
128   }
129 }
130 // If predefined expenses are configured, add controls to select an expense and quantity.
131 $predefined_expenses = ttTeamHelper::getPredefinedExpenses($user->group_id);
132 if ($predefined_expenses) {
133     $form->addInput(array('type'=>'combobox',
134       'onchange'=>'recalculateCost();',
135       'name'=>'predefined_expense',
136       'style'=>'width: 250px;',
137       'value'=>$cl_predefined_expense,
138       'data'=>$predefined_expenses,
139       'datakeys'=>array('id', 'name'),
140       'empty'=>array(''=>$i18n->get('dropdown.select'))));
141     $form->addInput(array('type'=>'text','onchange'=>'recalculateCost();','maxlength'=>'40','name'=>'quantity','style'=>'width: 100px;','value'=>$cl_quantity));
142 }
143 $form->addInput(array('type'=>'textarea','maxlength'=>'800','name'=>'item_name','style'=>'width: 250px; height:'.NOTE_INPUT_HEIGHT.'px;','value'=>$cl_item_name));
144 $form->addInput(array('type'=>'text','maxlength'=>'40','name'=>'cost','style'=>'width: 100px;','value'=>$cl_cost));
145 if ($user->can('manage_invoices') && $user->isPluginEnabled('ps'))
146   $form->addInput(array('type'=>'checkbox','name'=>'paid','value'=>$cl_paid));
147 $form->addInput(array('type'=>'datefield','name'=>'date','maxlength'=>'20','value'=>$cl_date));
148 // Hidden control for record id.
149 $form->addInput(array('type'=>'hidden','name'=>'id','value'=>$cl_id));
150 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on btn_save or btn_copy click.
151 $on_click_action = 'browser_today.value=get_date();';
152 $form->addInput(array('type'=>'submit','name'=>'btn_copy','onclick'=>$on_click_action,'value'=>$i18n->get('button.copy')));
153 if ($confirm_save) $on_click_action .= 'return(confirmSave());';
154 $form->addInput(array('type'=>'submit','name'=>'btn_save','onclick'=>$on_click_action,'value'=>$i18n->get('button.save')));
155 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->get('label.delete')));
156
157 if ($request->isPost()) {
158   // Validate user input.
159   if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
160     $err->add($i18n->get('error.client'));
161   if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
162     if (!$cl_project) $err->add($i18n->get('error.project'));
163   }
164   if (!ttValidString($cl_item_name)) $err->add($i18n->get('error.field'), $i18n->get('label.item'));
165   if (!ttValidFloat($cl_cost)) $err->add($i18n->get('error.field'), $i18n->get('label.cost'));
166   if (!ttValidDate($cl_date)) $err->add($i18n->get('error.field'), $i18n->get('label.date'));
167
168   // This is a new date for the expense item.
169   $new_date = new DateAndTime($user->date_format, $cl_date);
170
171   // Prohibit creating entries in future.
172   if (!$user->future_entries) {
173     $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
174     if ($new_date->after($browser_today))
175       $err->add($i18n->get('error.future_date'));
176   }
177
178   // Save record.
179   if ($request->getParameter('btn_save')) {
180     // We need to:
181     // 1) Prohibit updating locked entries (that are in locked range).
182     // 2) Prohibit saving unlocked entries into locked range.
183
184     // Now, step by step.
185     // 1) Prohibit saving locked entries in any form.
186     if ($user->isDateLocked($item_date))
187       $err->add($i18n->get('error.range_locked'));
188
189     // 2) Prohibit saving unlocked entries into locked range.
190     if ($err->no() && $user->isDateLocked($new_date))
191       $err->add($i18n->get('error.range_locked'));
192
193     // Now, an update.
194     if ($err->no()) {
195       if (ttExpenseHelper::update(array('id'=>$cl_id,'date'=>$new_date->toString(DB_DATEFORMAT),'user_id'=>$user->getUser(),
196           'client_id'=>$cl_client,'project_id'=>$cl_project,'name'=>$cl_item_name,'cost'=>$cl_cost,'paid'=>$cl_paid))) {
197         header('Location: expenses.php?date='.$new_date->toString(DB_DATEFORMAT));
198         exit();
199       }
200     }
201   }
202
203   // Save as new record.
204   if ($request->getParameter('btn_copy')) {
205     // We need to prohibit saving into locked interval.
206     if ($user->isDateLocked($new_date))
207       $err->add($i18n->get('error.range_locked'));
208
209     // Now, a new insert.
210     if ($err->no()) {
211       if (ttExpenseHelper::insert(array('date'=>$new_date->toString(DB_DATEFORMAT),'client_id'=>$cl_client,
212           'project_id'=>$cl_project,'name'=>$cl_item_name,'cost'=>$cl_cost,'status'=>1))) {
213         header('Location: expenses.php?date='.$new_date->toString(DB_DATEFORMAT));
214         exit();
215       } else
216         $err->add($i18n->get('error.db'));
217     }
218   }
219
220   if ($request->getParameter('btn_delete')) {
221     header("Location: expense_delete.php?id=$cl_id");
222     exit();
223   }
224 } // isPost
225
226 if ($confirm_save) {
227   $smarty->assign('confirm_save', true);
228   $smarty->assign('entry_date', $cl_date);
229 }
230 $smarty->assign('predefined_expenses', $predefined_expenses);
231 $smarty->assign('client_list', $client_list);
232 $smarty->assign('project_list', $project_list);
233 $smarty->assign('task_list', $task_list);
234 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
235 $smarty->assign('title', $i18n->get('title.edit_expense'));
236 $smarty->assign('content_page_name', 'expense_edit.tpl');
237 $smarty->display('index.tpl');