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 // ttFileHelper class is used for attachment handling.
31 var $errors = null; // Errors go here. Set in constructor by reference.
32 var $storage_uri = null; // Location of file storage facility.
33 var $register_uri = null; // URI to register with file storage facility.
34 var $putfile_uri = null; // URI to put file in file storage.
35 var $getfile_uri = null; // URI to get file from file storage.
36 var $site_id = null; // Site id for file storage.
37 var $site_key = null; // Site key for file storage.
40 function __construct(&$errors) {
41 $this->errors = &$errors;
43 if (defined('FILE_STORAGE_URI')) {
44 $this->storage_uri = FILE_STORAGE_URI;
45 $this->register_uri = $this->storage_uri.'register';
46 $this->putfile_uri = $this->storage_uri.'putfile';
47 $this->getfile_uri = $this->storage_uri.'getfile';
48 $this->checkSiteRegistration();
52 // checkSiteRegistration - obtains site id and key from local database.
53 // If not found, it tries to register with file storage facility.
54 function checkSiteRegistration() {
57 $mdb2 = getConnection();
60 $sql = "select param_value as id from tt_site_config where param_name = 'locker_id'";
61 $res = $mdb2->query($sql);
62 $val = $res->fetchRow();
64 // No site id found, need to register.
65 $fields = array('name' => urlencode('time tracker'),
66 'origin' => urlencode('time tracker source'));
68 // Urlify the data for the POST.
69 foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
70 $fields_string = rtrim($fields_string, '&');
75 // Set the url, number of POST vars, POST data.
76 curl_setopt($ch, CURLOPT_URL, $this->register_uri);
77 curl_setopt($ch, CURLOPT_POST, count($fields));
78 curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
79 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
81 // Execute a post request.
82 $result = curl_exec($ch);
87 $result_array = json_decode($result, true);
88 if ($result_array && $result_array['id'] && $result_array['key']) {
90 $this->site_id = $result_array['id'];
91 $this->site_key = $result_array['key'];
93 // Registration successful. Store id and key locally for future use.
94 $sql = "insert into tt_site_config values('locker_id', $this->site_id, now(), null)";
96 $sql = "insert into tt_site_config values('locker_key', ".$mdb2->quote($this->site_key).", now(), null)";
99 $this->errors->add($i18n->get('error.file_storage'));
102 // Site id found, need to update site attributes.
103 $this->site_id = $val['id'];
106 $sql = "select param_value as site_key from tt_site_config where param_name = 'locker_key'";
107 $res = $mdb2->query($sql);
108 $val = $res->fetchRow();
109 $this->site_key = $val['site_key'];
113 // putFile - puts uploaded file in remote storage.
114 function putFile($fields) {
115 // if (!$this->site_id || !$this->site_key) return false;
119 $mdb2 = getConnection();
121 $group_id = $user->getGroup();
122 $org_id = $user->org_id;
124 $fields = array('site_id' => urlencode($this->site_id),
125 'site_key' => urlencode($this->site_key),
126 'org_id' => urlencode($org_id),
127 //'org_key' => urlencode($this->org_key), // TODO: obtain this properly.
128 'group_id' => urlencode($group_id),
129 //'group_key' => urlencode($this->group_key), // TODO: obtain this properly.
130 //'user_id' => urlencode($this->user_id), // TODO: obtain this properly.
131 //'user_key' => urlencode($this->user_key), // TODO: obtain this properly.
132 'file_name' => urlencode($fields['file_name']),
133 'description' => urlencode($fields['description']),
134 // TODO: add file content here, too. Will this work for large files?
138 // url-ify the data for the POST.
139 foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
140 $fields_string = rtrim($fields_string, '&');
145 // Set the url, number of POST vars, POST data.
146 curl_setopt($ch, CURLOPT_URL, $this->putfile_uri);
147 curl_setopt($ch, CURLOPT_POST, count($fields));
148 curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
149 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
151 // Execute a post rewuest.
152 $result = curl_exec($ch);
157 // Delete uploaded file.
158 unlink($_FILES['newfile']['tmp_name']);
160 if (!$result) return false;
162 $result_array = json_decode($result, true);
163 $file_id = (int) $result_array['file_id'];
164 $file_key = $result_array['file_key'];
165 $file_error = $result_array['file_error'];
167 if (!$file_id || !$file_key) {
169 // Add an error from file storage facility if we have it.
170 $this->errors->add($file_error);
175 // File put was successful. Store file attributes locally.
176 $entity_type = $mdb2->quote($fields['entity_type']);
177 $entity_id = (int) $fields['entity_id'];
178 $file_name = $mdb2->quote($fields['file_name']);
179 $description = $mdb2->quote($fields['description']);
181 $created_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
182 $created_by = $user->id;
184 $columns = '(group_id, org_id, remote_id, entity_type, entity_id, file_name, description, created, created_ip, created_by)';
185 $values = "values($group_id, $org_id, $file_id, $entity_type, $entity_id, $file_name, $description, $created, $created_ip, $created_by)";
186 $sql = "insert into tt_files $columns $values";
187 $affected = $mdb2->exec($sql);
188 return (!is_a($affected, 'PEAR_Error'));