Merge pull request #569 from LearningLocker/issue/attachments

Returns attachments when attachments set to true.

Author: ryasmi

app/controllers/xapi/StatementController.php

@@ -222,11 +222,30 @@ public function index() {
     }
 
     // Returns the StatementResult object.
-    return $this->makeStatementObject($statements, [
+    $statement_result = json_encode($this->makeStatementObject($statements, [
       'total' => $total,
       'offset' => $options['offset'],
       'limit' => $options['limit']
-    ]);
+    ]));
+
+    if ($options['attachments'] === true) {
+      $boundary = 'abcABC0123\'()+_,-./:=?';
+      $content_type = 'multipart/mixed; boundary='.$boundary;
+      $statement_result = "Content-Type:application/json\r\n\r\n".$statement_result;
+      $body = "--$boundary\r\n".implode(
+        "\r\n--$boundary\r\n",
+        array_merge([$statement_result], $this->statement->getAttachments($statements, $this->lrs->_id))
+      )."\r\n--$boundary--";
+    } else {
+      $content_type = 'application/json;';
+      $body = $statement_result;
+    }
+
+    // Creates the response.
+    return \Response::make($body, BaseController::OK, [
+      'Content-Type' => $content_type,
+      'X-Experience-API-Consistent-Through' => $this->statement->getCurrentDate()
+    ]);;
   }
 
   /**
@@ -274,19 +293,12 @@ private function makeStatementObject(array $statements, array $options) {
     }
 
     // Creates the statement result.
-    $statementResult = [
+    $statement_result = [
       'more' => $this->getMoreLink($options['total'], $options['limit'], $options['offset']),
       'statements' => $statements
     ];
 
-    // Creates the response.
-    $response = \Response::make($statementResult, BaseController::OK);
-    $response->headers->set(
-      'X-Experience-API-Consistent-Through',
-      $this->statement->getCurrentDate()
-    );
-
-    return $response;
+    return $statement_result;
   }
 
   /**

app/database/migrations/2015_02_13_100706_statement_id_index.php

@@ -16,5 +16,4 @@ public function down() {
       $table->dropIndex(['statement.id', 'lrs._id']);
     });
 	}
-
 }

app/database/migrations/2015_02_25_154357_document_sha.php

@@ -11,10 +11,10 @@ public function up() {
         $document->sha = trim($document->sha, '"');
         $document->save();
       }
-      echo(count($documents) . ' converted.');
+      echo(count($documents) . ' converted.').PHP_EOL;
     });
 
-    echo('All finished, hopefully!');
+    echo('All finished, hopefully!').PHP_EOL;
 	}
 
 	public function down() {
@@ -23,10 +23,10 @@ public function down() {
         $document->sha = '"'.trim($document->sha, '"').'"';
         $document->save();
       }
-      echo(count($documents) . ' converted.');
+      echo(count($documents) . ' converted.').PHP_EOL;
     });
 
-    echo('All finished, hopefully!');
+    echo('All finished, hopefully!').PHP_EOL;
 	}
 }
 

app/database/migrations/2015_03_31_130813_attachment_rename.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+use \Locker\Helpers\Helpers as Helpers;
+
+class AttachmentRename extends Migration {
+
+  public function up() {
+    $uploads = Helpers::getEnvVar('LOCAL_FILESTORE');
+    $LRSs = $this->getDirectores($uploads);
+    
+    // Gets the attachments.
+    $attachments = [];
+    foreach ($LRSs as $lrs) {
+      $attachments = array_merge($attachments, array_map(function ($dir) use ($uploads, $lrs) {
+        return $uploads.'/'.$lrs.'/attachments/'.$dir;
+      }, $this->getDirectores(
+        $uploads.'/'.$lrs.'/attachments'
+      )));
+    }
+
+    // Migrates the attachments.
+    foreach ($attachments as $attachment) {
+      $file = $attachment.'/'.scandir($attachment)[2];
+      $ext = pathinfo($file, PATHINFO_EXTENSION);
+      file_put_contents($attachment.'.'.$ext, file_get_contents($file));
+    }
+
+    echo 'Migrated '.count($attachments)." attachments.".PHP_EOL;
+  }
+
+  private function getDirectores($path) {
+    return array_values(array_filter(scandir($path), function ($name) use ($path) {
+      return $name[0] !== '.' && is_dir($path.'/'.$name);
+    }));
+  }
+
+  public function down() {
+    
+  }
+}

app/locker/repository/Statement/EloquentStatementRepository.php

@@ -851,13 +851,34 @@ private function doesStatementIdExist($lrsId, array $statement) {
     return null;
   }
 
+  public function getAttachments($statements, $lrs) {
+    $destination_path = Helpers::getEnvVar('LOCAL_FILESTORE').'/'.$lrs.'/attachments/';
+    $attachments = [];
+
+    foreach ($statements as $statement) {
+      $statement = $statement['statement'];
+      $attachments = array_merge($attachments, array_map(function ($attachment) use ($destination_path) {
+        $ext = array_search($attachment['contentType'], FileTypes::getMap());
+        $filename = $attachment['sha2'].'.'.$ext;
+        return (
+          'Content-Type:'.$attachment['contentType']."\r\n".
+          'Content-Transfer-Encoding:binary'."\r\n".
+          'X-Experience-API-Hash:'.$attachment['sha2'].
+          "\r\n\r\n".
+          file_get_contents($destination_path.$filename)
+        );
+      }, isset($statement['attachments']) ? $statement['attachments'] : []));
+    }
+
+    return $attachments;
+  }
+
   /**
    * Store any attachments
    *
    **/
   private function storeAttachments( $attachments, $lrs ){
-
-    foreach( $attachments as $attachment ){
+    foreach ($attachments as $attachment) {
       // Determines the delimiter.
       $delim = "\n";
       if (strpos($attachment, "\r".$delim) !== false) $delim = "\r".$delim;
@@ -868,35 +889,34 @@ private function storeAttachments( $attachments, $lrs ){
 
       // Parse headers and separate so we can access
       $raw_headers = explode($delim, $raw_headers);
-      $headers     = array();
+      $headers = [];
       foreach ($raw_headers as $header) {
         list($name, $value) = explode(':', $header);
         $headers[strtolower($name)] = ltrim($value, ' ');
       }
 
       //get the correct ext if valid
-      $ext = array_search( $headers['content-type'], FileTypes::getMap() );
-      if( $ext === false ){
-        \App::abort(400, 'This file type cannot be supported');
-      }
+      $ext = array_search($headers['content-type'], FileTypes::getMap());
+      if ($ext === false)  throw new Exceptions\Exception(
+        'This file type cannot be supported'
+      );
 
-      $filename = str_random(12) . "." . $ext;
+      $destination_path = Helpers::getEnvVar('LOCAL_FILESTORE').'/'.$lrs.'/attachments/';
+      $filename = $headers['x-experience-api-hash'];
 
       //create directory if it doesn't exist
-      if (!\File::exists(Helpers::getEnvVar('LOCAL_FILESTORE').'/'.$lrs.'/attachments/' . $headers['x-experience-api-hash'] . '/')) {
-        \File::makeDirectory(Helpers::getEnvVar('LOCAL_FILESTORE').'/'.$lrs.'/attachments/' . $headers['x-experience-api-hash'] . '/', 0775, true);
+      if (!\File::exists($destination_path)) {
+        \File::makeDirectory($destination_path, 0775, true);
       }
 
-      $destinationPath = Helpers::getEnvVar('LOCAL_FILESTORE').'/'.$lrs.'/attachments/' . $headers['x-experience-api-hash'] . '/';
-
-      $filename = $destinationPath.$filename;
-      $file = fopen( $filename, 'wb'); //opens the file for writing with a BINARY (b) fla
-      $size = fwrite( $file, $body ); //write the data to the file
-      fclose( $file );
+      $filename = $destination_path.$filename.'.'.$ext;
+      $file = fopen($filename, 'wb'); //opens the file for writing with a BINARY (b) fla
+      $size = fwrite($file, $body); //write the data to the file
+      fclose($file);
 
-      if( $size === false ){
-        \App::abort( 400, 'There was an issue saving the attachment');
-      }
+      if($size === false) throw new Exceptions\Exception(
+        'There was an issue saving the attachment'
+      );
     }
 
   }