Improved new export by adding projects in output.
[timetracker.git] / WEB-INF / lib / ttGroupExportHelper.class.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 // ttGroupExportHelper - this class is used to write data for a single group
30 // to a file. When group contains other groups, it reuses itself recursively.
31 //
32 // Currently, it is work in progress.
33 // When done, it should handle export of organizations containing multiple groups.
34 class ttGroupExportHelper {
35
36   var $group_id = null;     // Group we are exporting.
37   var $file     = null;     // File to write to.
38   var $indentation = null;  // A string consisting of a number of spaces.
39   var $subgroups = array(); // Immediate subgroups.
40
41   // The following arrays are maps between entity ids in the file versus the database.
42   // We write to the file sequentially (1,2,3...) while in the database the entities have different ids.
43   var $userMap    = array(); // User ids.
44   var $roleMap    = array(); // Role ids.
45   var $taskMap    = array(); // Task ids.
46   var $projectMap = array(); // Project ids.
47   var $clientMap  = array(); // Client ids.
48
49   // Constructor.
50   function __construct($group_id, $file, $indentation) {
51     global $user;
52
53     $this->group_id = $group_id;
54     $this->file = $file;
55     $this->indentation = $indentation;
56
57     // Build a list of subgroups.
58     $mdb2 = getConnection();
59     $sql =  "select id from tt_groups".
60             " where status = 1 and parent_id = $this->group_id and org_id = $user->org_id";
61     $res = $mdb2->query($sql);
62     if (!is_a($res, 'PEAR_Error')) {
63       while ($val = $res->fetchRow()) {
64         $this->subgroups[] = $val;
65       }
66     }
67   }
68
69   // getGroupData obtains group attributes for export.
70   function getGroupData() {
71     global $user;
72     $mdb2 = getConnection();
73
74     $sql =  "select name, currency, lang from tt_groups".
75             " where status = 1 and id = $this->group_id and org_id = $user->org_id";
76     $res = $mdb2->query($sql);
77     if (!is_a($res, 'PEAR_Error')) {
78       $val = $res->fetchRow();
79     }
80     return $val;
81   }
82
83   // The getUsers obtains all users in group for the purpose of export.
84   function getUsers() {
85     global $user;
86     $mdb2 = getConnection();
87
88     $sql = "select u.*, r.rank from tt_users u left join tt_roles r on (u.role_id = r.id)".
89       " where u.group_id = $this->group_id and u.org_id = $user->org_id order by upper(u.name)"; // Note: deleted users are included.
90     $res = $mdb2->query($sql);
91     $result = array();
92     if (!is_a($res, 'PEAR_Error')) {
93       while ($val = $res->fetchRow()) {
94         $result[] = $val;
95       }
96       return $result;
97     }
98     return false;
99   }
100
101   // getRoles - obtains all roles defined for group.
102   function getRoles() {
103     global $user;
104     $mdb2 = getConnection();
105
106     $result = array();
107     $sql = "select * from tt_roles where group_id = $this->group_id and org_id = $user->org_id";
108     $res = $mdb2->query($sql);
109     $result = array();
110     if (!is_a($res, 'PEAR_Error')) {
111       while ($val = $res->fetchRow()) {
112         $result[] = $val;
113       }
114       return $result;
115     }
116     return false;
117   }
118
119   // getTasks - obtains all tasks defined for group.
120   function getTasks() {
121     global $user;
122     $mdb2 = getConnection();
123
124     $result = array();
125     $sql = "select * from tt_tasks where group_id = $this->group_id and org_id = $user->org_id";
126     $res = $mdb2->query($sql);
127     $result = array();
128     if (!is_a($res, 'PEAR_Error')) {
129       while ($val = $res->fetchRow()) {
130         $result[] = $val;
131       }
132       return $result;
133     }
134     return false;
135   }
136
137   // getProjects - obtains all projects defined for group.
138   function getProjects() {
139     global $user;
140     $mdb2 = getConnection();
141
142     $result = array();
143     $sql = "select * from tt_projects where group_id = $this->group_id and org_id = $user->org_id";
144     $res = $mdb2->query($sql);
145     $result = array();
146     if (!is_a($res, 'PEAR_Error')) {
147       while ($val = $res->fetchRow()) {
148         $result[] = $val;
149       }
150       return $result;
151     }
152     return false;
153   }
154
155   // writeData writes group data into file.
156   function writeData() {
157
158     // Write group info.
159     $group = $this->getGroupData();
160     $group_part = "<group name=\"".htmlentities($group['name'])."\"";
161     $group_part .= " currency=\"".htmlentities($group['currency'])."\"";
162     $group_part .= " lang=\"".$group['lang']."\"";
163     // TODO: add other group attributes here.
164     $group_part .= ">\n";
165
166     // Write group info.
167     fwrite($this->file, $this->indentation.$group_part);
168
169     // Prepare user map.
170     $users = $this->getUsers();
171     foreach ($users as $key=>$user_item)
172       $this->userMap[$user_item['id']] = $key + 1;
173
174     // Prepare role map.
175     $roles = $this->getRoles();
176     foreach ($roles as $key=>$role_item)
177       $this->roleMap[$role_item['id']] = $key + 1;
178
179     // Prepare task map.
180     $tasks = $this->getTasks();
181     foreach ($tasks as $key=>$task_item)
182       $this->taskMap[$task_item['id']] = $key + 1;
183
184     // Prepare project map.
185     $projects = $this->getProjects();
186     foreach ($projects as $key=>$project_item)
187       $this->projectMap[$project_item['id']] = $key + 1;
188
189     // Prepare client map.
190     $clients = ttTeamHelper::getAllClients($this->group_id, true);
191     foreach ($clients as $key=>$client_item)
192       $this->clientMap[$client_item['id']] = $key + 1;
193
194     // Write roles.
195     fwrite($this->file, $this->indentation."  <roles>\n");
196     foreach ($roles as $role) {
197       $role_part = $this->indentation.'    '."<role id=\"".$this->roleMap[$role['id']]."\"";
198       $role_part .= " name=\"".htmlentities($role['name'])."\"";
199       $role_part .= " description=\"".htmlentities($role['description'])."\"";
200       $role_part .= " rank=\"".$role['rank']."\"";
201       $role_part .= " rights=\"".htmlentities($role['rights'])."\"";
202       $role_part .= " status=\"".$role['status']."\"";
203       $role_part .= "></role>\n";
204       fwrite($this->file, $role_part);
205     }
206     fwrite($this->file, $this->indentation."  </roles>\n");
207
208     // Write tasks.
209     fwrite($this->file, $this->indentation."  <tasks>\n");
210     foreach ($tasks as $task) {
211       $task_part = $this->indentation.'    '."<task id=\"".$this->taskMap[$task['id']]."\"";
212       $task_part .= " name=\"".htmlentities($task['name'])."\"";
213       $task_part .= " description=\"".htmlentities($task['description'])."\"";
214       $task_part .= " status=\"".$task['status']."\"";
215       $task_part .= "></task>\n";
216       fwrite($this->file, $task_part);
217     }
218     fwrite($this->file, $this->indentation."  </tasks>\n");
219
220     // Write projects.
221     fwrite($this->file, $this->indentation."  <projects>\n");
222     foreach ($projects as $project_item) {
223       if($project_item['tasks']){
224         $tasks = explode(',', $project_item['tasks']);
225         $tasks_mapped = array();
226         foreach ($tasks as $item)
227           $tasks_mapped[] = $this->taskMap[$item];
228         $tasks_str = implode(',', $tasks_mapped);
229       }
230       $project_part = $this->indentation.'    '."<project id=\"".$this->projectMap[$project_item['id']]."\"";
231       $project_part .= " name=\"".htmlentities($project_item['name'])."\"";
232       $project_part .= " description=\"".htmlentities($project_item['description'])."\"";
233       $project_part .= " tasks=\"".$tasks_str."\"";
234       $project_part .= " status=\"".$project_item['status']."\"";
235       $project_part .= "></project>\n";
236       fwrite($this->file, $project_part);
237     }
238     fwrite($this->file, $this->indentation."  </projects>\n");
239
240     // Write users.
241     fwrite($this->file, $this->indentation."  <users>\n");
242     foreach ($users as $user_item) {
243       $role_id = $user_item['rank'] == 512 ? 0 : $this->roleMap[$user_item['role_id']]; // Special role_id 0 (not null) for top manager.
244       $user_part = $this->indentation.'    '."<user id=\"".$this->userMap[$user_item['id']]."\"";
245       $user_part .= " name=\"".htmlentities($user_item['name'])."\"";
246       $user_part .= " login=\"".htmlentities($user_item['login'])."\"";
247       $user_part .= " password=\"".$user_item['password']."\"";
248       $user_part .= " role_id=\"".$role_id."\"";
249       $user_part .= " client_id=\"".$this->clientMap[$user_item['client_id']]."\"";
250       $user_part .= " rate=\"".$user_item['rate']."\"";
251       $user_part .= " email=\"".$user_item['email']."\"";
252       $user_part .= " status=\"".$user_item['status']."\"";
253       $user_part .= "></user>\n";
254       fwrite($this->file, $user_part);
255     }
256     fwrite($this->file, $this->indentation."  </users>\n");
257
258     // Call self recursively for all subgroups.
259     foreach ($this->subgroups as $subgroup) {
260       $subgroup_helper = new ttGroupExportHelper($subgroup['id'], $this->file, $this->indentation.'  ');
261       $subgroup_helper->writeData();
262     }
263
264     fwrite($this->file, $this->indentation."</group>\n");
265   }
266 }