Wrote ttGroupHelper::deleteGroupFiles() function.
[timetracker.git] / WEB-INF / lib / ttFileHelper.class.php
index d44fa56..45b5b23 100644 (file)
@@ -32,9 +32,12 @@ class ttFileHelper {
   var $storage_uri = null;  // Location of file storage facility.
   var $register_uri = null; // URI to register with file storage facility.
   var $putfile_uri = null;  // URI to put file in file storage.
+  var $deletefile_uri = null;  // URI to delete file from file storage.
+  var $deletefiles_uri = null; // URI to delete multiple files from file storage.
   var $getfile_uri = null;  // URI to get file from file storage.
   var $site_id = null;      // Site id for file storage.
   var $site_key = null;     // Site key for file storage.
+  var $file_data = null;     // Downloaded file data.
 
   // Constructor.
   function __construct(&$errors) {
@@ -44,6 +47,8 @@ class ttFileHelper {
       $this->storage_uri = FILE_STORAGE_URI;
       $this->register_uri = $this->storage_uri.'register';
       $this->putfile_uri = $this->storage_uri.'putfile';
+      $this->deletefile_uri = $this->storage_uri.'deletefile';
+      $this->deletefiles_uri = $this->storage_uri.'deletefiles';
       $this->getfile_uri = $this->storage_uri.'getfile';
       $this->checkSiteRegistration();
     }
@@ -74,7 +79,7 @@ class ttFileHelper {
 
       // Set the url, number of POST vars, POST data.
       curl_setopt($ch, CURLOPT_URL, $this->register_uri);
-      curl_setopt($ch, CURLOPT_POST, count($fields));
+      curl_setopt($ch, CURLOPT_POST, true);
       curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
       curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
@@ -131,11 +136,11 @@ class ttFileHelper {
       'org_key' => urlencode($this->getOrgKey()),
       'group_id' => urlencode($group_id),
       'group_key' => urlencode($this->getGroupKey()),
-      'user_id' => urlencode($fields['user_id']),   // May be null.
-      'user_key' => urlencode($fields['user_key']), // May be null.
+      'entity_type' => urlencode($fields['entity_type']),
+      'entity_id' => urlencode($fields['entity_id']),
       'file_name' => urlencode($fields['file_name']),
       'description' => urlencode($fields['description']),
-      'content' => urlencode(file_get_contents($_FILES['newfile']['tmp_name']))
+      'content' => urlencode(base64_encode(file_get_contents($_FILES['newfile']['tmp_name'])))
     );
 
     // url-ify the data for the POST.
@@ -147,7 +152,7 @@ class ttFileHelper {
 
     // Set the url, number of POST vars, POST data.
     curl_setopt($ch, CURLOPT_URL, $this->putfile_uri);
-    curl_setopt($ch, CURLOPT_POST, count($fields));
+    curl_setopt($ch, CURLOPT_POST, true);
     curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
@@ -179,6 +184,7 @@ class ttFileHelper {
     }
 
     // File put was successful. Store file attributes locally.
+    $file_key = $mdb2->quote($file_key);
     $entity_type = $mdb2->quote($fields['entity_type']);
     $entity_id = (int) $fields['entity_id'];
     $file_name = $mdb2->quote($fields['file_name']);
@@ -187,8 +193,8 @@ class ttFileHelper {
     $created_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
     $created_by = $user->id;
 
-    $columns = '(group_id, org_id, remote_id, entity_type, entity_id, file_name, description, created, created_ip, created_by)';
-    $values = "values($group_id, $org_id, $file_id, $entity_type, $entity_id, $file_name, $description, $created, $created_ip, $created_by)";
+    $columns = '(group_id, org_id, remote_id, file_key, entity_type, entity_id, file_name, description, created, created_ip, created_by)';
+    $values = "values($group_id, $org_id, $file_id, $file_key, $entity_type, $entity_id, $file_name, $description, $created, $created_ip, $created_by)";
     $sql = "insert into tt_files $columns $values";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
@@ -209,11 +215,11 @@ class ttFileHelper {
       'org_key' => urlencode($this->getOrgKey()),
       'group_id' => urlencode($group_id),
       'group_key' => urlencode($this->getGroupKey()),
-      'user_id' => urlencode($fields['user_id']),   // May be null.
-      'user_key' => urlencode($fields['user_key']), // May be null.
+      'entity_type' => urlencode($fields['entity_type']),
+      'entity_id' => urlencode($fields['entity_id']),
       'file_id' => urlencode($fields['remote_id']),
-      'file_key' => urlencode($fields['file_key'])
-    );
+      'file_key' => urlencode($fields['file_key']),
+      'file_name' => urlencode($fields['file_name']));
 
     // url-ify the data for the POST.
     foreach($curl_fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
@@ -223,8 +229,8 @@ class ttFileHelper {
     $ch = curl_init();
 
     // Set the url, number of POST vars, POST data.
-    curl_setopt($ch, CURLOPT_URL, $this->putfile_uri);
-    curl_setopt($ch, CURLOPT_POST, count($fields));
+    curl_setopt($ch, CURLOPT_URL, $this->deletefile_uri);
+    curl_setopt($ch, CURLOPT_POST, true);
     curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
@@ -240,22 +246,103 @@ class ttFileHelper {
     }
 
     $result_array = json_decode($result, true);
-    // $status = (int) $result_array['status'];
+    $status = (int) $result_array['status'];
     $error = $result_array['error'];
 
     if ($error) {
       // Add an error from file storage facility if we have it.
       $this->errors->add($error);
+    }
+    if ($status != 1) {
+      // There is no explicit error message, but still something not right.
+      $this->errors->add($i18n->get('error.file_storage'));
+    }
+
+    // Delete file reference from database even when remote file storage call fails.
+    // This is by design to keep things simple.
+    $file_id = (int) $fields['id'];
+    $entity_id = (int) $fields['entity_id'];
+    $sql = "delete from tt_files".
+      " where id = $file_id and org_id = $org_id and group_id = $group_id and entity_id = $entity_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error')) {
+      $this->errors->add($i18n->get('error.db'));
       return false;
     }
 
-    // Delete file reference from database.
-    $file_id = $file['id'];
+    // File successfully deleted from both file storage and database.
+    return true;
+  }
+
+  // deleteEntityFiles - deletes all files associated with an entity.
+  function deleteEntityFiles($entity_id, $entity_type) {
+
+    global $i18n;
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $curl_fields = array('site_id' => urlencode($this->site_id),
+      'site_key' => urlencode($this->site_key),
+      'org_id' => urlencode($org_id),
+      'org_key' => urlencode($this->getOrgKey()),
+      'group_id' => urlencode($group_id),
+      'group_key' => urlencode($this->getGroupKey()),
+      'entity_type' => urlencode($entity_type),
+      'entity_id' => urlencode($entity_id));
+
+    // url-ify the data for the POST.
+    foreach($curl_fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
+    $fields_string = rtrim($fields_string, '&');
+
+    // Open connection.
+    $ch = curl_init();
+
+    // Set the url, number of POST vars, POST data.
+    curl_setopt($ch, CURLOPT_URL, $this->deletefiles_uri);
+    curl_setopt($ch, CURLOPT_POST, true);
+    curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+    // Execute a post request.
+    $result = curl_exec($ch);
+
+    // Close connection.
+    curl_close($ch);
+
+    if (!$result) {
+      $this->errors->add($i18n->get('error.file_storage'));
+      return false;
+    }
+
+    $result_array = json_decode($result, true);
+    $status = (int) $result_array['status'];
+    $error = $result_array['error'];
+
+    if ($error) {
+      // Add an error from file storage facility if we have it.
+      $this->errors->add($error);
+    }
+    if ($status != 1) {
+      // There is no explicit error message, but still something not right.
+      $this->errors->add($i18n->get('error.file_storage'));
+    }
+
+    // Many things can go wrong with a remote call to file storage facility.
+    // By design, we ignore such errors, and proceed with removal of entity
+    // records from the database.
+
+    // Delete all entity records from the database.
+    $file_id = $fields['id'];
     $sql = "delete from tt_files".
-      " where id = $file_id and org_id = $org_id and group_id = $group_id";
+      " where entity_id = $entity_id".
+      " and entity_type = ".$mdb2->quote($entity_type).
+      " and org_id = $org_id and group_id = $group_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) {
-      $err->add($i18n->get('error.db'));
+      $this->errors->add($i18n->get('error.db'));
       return false;
     }
 
@@ -288,8 +375,8 @@ class ttFileHelper {
     return $val['group_key'];
   }
 
-  // getProjectFiles obtains a list of files for a project.
-  function getProjectFiles($project_id) {
+  // getEntityFiles obtains a list of files for an entity.
+  static function getEntityFiles($id, $type) {
     global $user;
     $mdb2 = getConnection();
 
@@ -297,8 +384,9 @@ class ttFileHelper {
     $org_id = $user->org_id;
 
     $result = array();
-    $sql = "select id, remote_id, file_name as name, description from tt_files".
-      " where entity_type = 'project' and entity_id = $project_id".
+    $entity_type = $mdb2->quote($type);
+    $sql = "select id, remote_id, file_key, file_name as name, description from tt_files".
+      " where entity_type = $entity_type and entity_id = $id".
       " and group_id = $group_id and org_id = $org_id and status = 1 order by id";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
@@ -327,4 +415,95 @@ class ttFileHelper {
     }
     return false;
   }
+
+  // update - updates file details in local database.
+  static function update($fields) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $file_id = (int) $fields['id'];
+    $description = $mdb2->quote($fields['description']);
+
+    $sql = "update tt_files set description = $description where id = $file_id".
+      " and group_id = $group_id and org_id = $org_id and (status = 0 or status = 1)";
+    $affected = $mdb2->exec($sql);
+    return !is_a($affected, 'PEAR_Error');
+  }
+
+
+  // getFile - downloads file from remote storage to memory.
+  function getFile($fields) {
+    global $i18n;
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $curl_fields = array('site_id' => urlencode($this->site_id),
+      'site_key' => urlencode($this->site_key),
+      'org_id' => urlencode($org_id),
+      'org_key' => urlencode($this->getOrgKey()),
+      'group_id' => urlencode($group_id),
+      'group_key' => urlencode($this->getGroupKey()),
+      'entity_type' => urlencode($fields['entity_type']),
+      'entity_id' => urlencode($fields['entity_id']),
+      'file_id' => urlencode($fields['remote_id']),
+      'file_key' => urlencode($fields['file_key']),
+      'file_name' => urlencode($fields['file_name']));
+
+    // url-ify the data for the POST.
+    foreach($curl_fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
+    $fields_string = rtrim($fields_string, '&');
+
+    // Open connection.
+    $ch = curl_init();
+
+    // Set the url, number of POST vars, POST data.
+    curl_setopt($ch, CURLOPT_URL, $this->getfile_uri);
+    curl_setopt($ch, CURLOPT_POST, true);
+    curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+    // Execute a post request.
+    $result = curl_exec($ch);
+
+    $error = curl_error();
+    $result_array2 = json_decode($result, true);
+
+    // Close connection.
+    curl_close($ch);
+
+    if (!$result) {
+      $this->errors->add($i18n->get('error.file_storage'));
+      return false;
+    }
+
+    $result_array = json_decode($result, true);
+    $status = (int) $result_array['status'];
+    $error = $result_array['error'];
+
+    if ($error) {
+      // Add an error from file storage facility if we have it.
+      $this->errors->add($error);
+      return false;
+    }
+    if ($status != 1) {
+      // There is no explicit error message, but still something not right.
+      $this->errors->add($i18n->get('error.file_storage'));
+      return false;
+    }
+
+    $this->file_data = $result_array['content'];
+    return true;
+  }
+
+
+  // getFileData - returns file data from memory.
+  function getFileData() {
+    return base64_decode($this->file_data);
+  }
 }