Merge pull request #232 from piql/release/v1.0

Publish official release of PiqlConnect v1.0

Author: hakonlarsson

.env.example

@@ -18,10 +18,10 @@ APP_URL=http://_HOSTNAME_
 # sent with bags
 #APP_AM_INGEST_METADATA_FILE_FORMAT=csv
 
-# APP_INGEST_BUCKET_SIZE (default = 115000000000)
+# APP_INGEST_BUCKET_SIZE (default = 120000000000)
 # After a complete ingest AIPs are added to a bucket
 # Sets the maximum bucket size in bytes
-#APP_INGEST_BUCKET_SIZE=115000000000
+#APP_INGEST_BUCKET_SIZE=120000000000
 
 # Ingest validation service (default = App\Services\IngestValidationService)
 #APP_INGEST_VALIDATION_SERVICE=App\Services\IngestValidationService
@@ -31,9 +31,22 @@ APP_URL=http://_HOSTNAME_
 
 # Uploder path
 STORAGE_UPLOADER_PATH=uploader
+
 # Bag path
 STORAGE_BAGS_PATH=bags
 
+# Job path
+STORAGE_JOBS_PATH=jobs
+
+# Messages processing path
+STORAGE_MESSAGES_PROCESSING_PATH=messages-processing
+
+# Messages processed path
+STORAGE_MESSAGES_PROCESSED_PATH=messages-processed
+
+# Messages failed path
+STORAGE_MESSAGES_FAILED_PATH=messages-failed
+
 # Archivematica transfer path
 # This is where ingested bags are stored
 STORAGE_TRANSFER_PATH=am/ss-location-data
@@ -120,3 +133,14 @@ MONGO_DB_PORT=27017
 MONGO_DB_DATABASE=connectstats
 MONGO_DB_USERNAME=connectuser
 MONGO_DB_PASSWORD=Fw86TQZrJ5
+
+PIQLIT_NOTIFY_EMAIL_TO=
+
+# Authentication service base url
+APP_AUTH_SERVICE_BASE_URL=https://auth.piqlconnect.com
+# Authentication service realm
+APP_AUTH_SERVICE_REALM=development
+# Callback service client
+APP_AUTH_SERVICE_CALLBACK_CLIENT=piql-service-callback
+# Callback service client secret
+APP_AUTH_SERVICE_CALLBACK_CLIENT_SECRET=65b244cc-7a91-42cb-b997-5c22e7a3daa0

.env.testing.example

@@ -11,6 +11,10 @@ CURL_VERIFY_SELF_SIGN_CERT=true
 
 STORAGE_UPLOADER_PATH=uploader
 STORAGE_BAGS_PATH=bags
+STORAGE_JOBS_PATH=jobs
+STORAGE_MESSAGES_PROCESSING_PATH=messages-processing
+STORAGE_MESSAGES_PROCESSED_PATH=messages-processed
+STORAGE_MESSAGES_FAILED_PATH=messages-failed
 STORAGE_TRANSFER_PATH=am/ss-location-data
 STORAGE_LOCATION_ID=3bf2fd97-5350-4ace-a4dc-02045ae97076
 

.gitignore

@@ -48,4 +48,9 @@ package-lock.json
 *.js.snap
 
 .composer
-composer.phar
+composer.phar
+.rnd
+piql_connect.code-workspace
+resources/js/app.jse
+
+.vscode/settings.json

README.md

@@ -82,3 +82,30 @@ $ npm run dev
 
 To get piqlConnect rebuilt from your local shell.
 
+### End-to-end tests
+
+To perform user interface tests, you must run:
+
+```
+$ cd tests/endToEnd/
+$ ./ui-test.sh
+
+```
+
+It will open a background Chrome browser and navigate thoward some key actions in piqlConnect.
+
+All the actions happens inside "selenium/standalone-chrome" docker image.
+
+However it's possible to se theese actions if you change the image to a debug version.
+
+Edit "deploy/docker-compose.yml" file and append "-debug" to "selenium/standalone-chrome-chrome" image name:
+
+```
+  selenium-chrome:
+    image: selenium/standalone-chrome-chrome-debug
+
+```
+
+Stop the previous container and start the new one.
+
+Now you wil be able to use VNC at 5900 port and see Chrome running. Use VNC password "secret". 

app/Account.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace App;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use Webpatser\Uuid\Uuid;
+use Illuminate\Support\Facades\Validator;
+
+class Account extends Model
+{
+    const DEFAULT_TEMPLATE = '{ "title": "", "description": "", "dc":  { "identifier": "" } }';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'uuid',
+        'title',
+        'description',
+        'defaultMetadataTemplate'
+    ];
+
+    protected $attributes = [
+        'defaultMetadataTemplate' => self::DEFAULT_TEMPLATE
+    ];
+
+
+    protected $casts = [
+        'defaultMetadataTemplate' => 'array'
+    ];
+
+    protected static function boot()
+    {
+        parent::boot();
+
+        static::creating( function ( $model ) {
+            $validateIdentifier = Validator::make( ['uuid' => $model->uuid], ['uuid' => 'uuid'] );
+            if( !$validateIdentifier->passes() ){
+                $model->uuid = Str::uuid();
+            }
+
+            $userSuppliedData = $model->defaultMetadataTemplate["dc"] ?? [];
+            $model->defaultMetadataTemplate = ["dc" => ["identifier" => $model->uuid ] + $userSuppliedData ] ;
+        });
+    }
+
+    public function owner()
+    {
+        return $this->morphTo();
+    }
+
+    public function archives()
+    {
+        return $this->hasMany('App\Archive', 'account_uuid', 'uuid');
+    }
+
+    public function users()
+    {
+        return $this->hasMany('App\User', 'account_uuid', 'uuid');
+    }
+
+    public function getDefaultMetadataTemplateAttribute( string $template ) {
+        $ar = json_decode( $template, true );
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["identifier"] ) ) {
+            $ar["dc"]["identifier"] = $this->attributes["uuid"]; //The default is to use the uuid for the Archive as the identifier (as per spec.)
+        }
+
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["title"] ) ) {
+            $ar["dc"]["title"] = $this->attributes["title"] ?? "";  //TODO: accounts.title is nullable, not sure if this is ok?
+        }
+
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["description"] ) ) {
+            $ar["dc"]["description"] = $this->attributes["description"] ?? ""; //Grab the description from the model if not present in metadata template
+        }
+        return $ar;
+    }
+
+}

app/AccountMetadata.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App;
+
+use App\Traits\MorphableSelf;
+
+class AccountMetadata extends Metadata
+{
+    use MorphableSelf;
+}

app/Archive.php

@@ -2,30 +2,49 @@
 
 namespace App;
 
+use App\Traits\AutoGenerateUuid;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Webpatser\Uuid\Uuid;
-
+use Illuminate\Support\Str;
+use Illuminate\Support\Facades\Validator;
 
 class Archive extends Model
 {
     use SoftDeletes;
+    use AutoGenerateUuid;
+
+    const DEFAULT_TEMPLATE = '{ "title": "", "description": "", "dc":  { "identifier": "" } }';
 
     protected $table = 'archives';
     protected $fillable = [
-        'title','description','parent_uuid', 'uuid'
+        'title','description','parent_uuid', 'uuid', 'account_uuid', 'defaultMetadataTemplate'
+    ];
+    protected $casts = [
+        'defaultMetadataTemplate' => 'array'
+    ];
+
+    protected $attributes = [
+        'defaultMetadataTemplate' => self::DEFAULT_TEMPLATE
     ];
 
+
     protected static function boot()
     {
         parent::boot();
-        static::creating(function ($model) {
-            if(empty($model->uuid)){
-                $model->uuid = Uuid::generate()->string;
+
+        static::creating( function ( $model ) {
+            $validateIdentifier = Validator::make( ['uuid' => $model->uuid ], ['uuid' => 'uuid'] );
+            if( !$validateIdentifier->passes() ){
+                $model->uuid = Str::uuid();
             }
+
+            /* No identifier supplied, create one */
+            $userSuppliedData = $model->defaultMetadataTemplate["dc"];
+            $model->defaultMetadataTemplate = ["dc" => ["identifier" => $model->uuid ] + $userSuppliedData ] ;
         });
     }
-   
+
     public static function findByParentUuid($parent_uuid)
     {
         return Archive::where('parent_uuid', '=', $parent_uuid)->first();
@@ -54,5 +73,30 @@ public function holdings()
         return $this->hasMany('App\Holding', 'owner_archive_uuid', 'uuid');
     }
 
+    public function account() {
+        return $this->belongsTo(\App\Account::class, 'account_uuid', 'uuid');
+    }
+
+    public function getDefaultMetadataTemplateAttribute( string $template ) {
+        $ar = json_decode( $template, true );
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["identifier"] ) ) {
+            $ar["dc"]["identifier"] = $this->attributes["uuid"]; //The default is to use the uuid for the Archive as the identifier (as per spec.)
+        }
+
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["title"] ) ) {
+            $ar["dc"]["title"] = $this->attributes["title"];    //Grab the title from the model if not present in metadata template
+        }
+
+        if(isset( $ar["dc"] ) && !isset( $ar["dc"]["description"] ) ) {
+            $ar["dc"]["description"] = $this->attributes["description"] ?? ""; //Grab the description from the model if not present in metadata template
 
+        }
+        return $ar;
+    }
+
+    public function setDefaultMetadataTemplateAttribute( Array $template ) {
+        if( array_has( $template, 'dc' ) ) { //TODO: Support other schemas than DC, model level validation would be nice
+            $this->attributes['defaultMetadataTemplate'] = json_encode( $template );
+        }
+    }
 }

app/ArchiveMetadata.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App;
+
+use App\Traits\AutoGenerateUuid;
+use App\Traits\MorphableSelf;
+
+class ArchiveMetadata extends Metadata
+{
+    use MorphableSelf;
+}

app/Auth/User.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace App\Auth;
+
+use App\File;
+use Exception;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class User extends Authenticatable
+{
+    public function getIdAttribute()
+    {
+        return isset($this->token) ? $this->token->sub : $this->sub;
+    }
+
+    public function settings()
+    {
+        //todo: remove this at the point when we can create keycloak users via this client
+        if(!\App\UserSetting::where([ 'user_id' => $this->getIdAttribute()])->exists())
+            \App\UserSetting::create([ 'user_id' => $this->getIdAttribute() ]);
+        return $this->hasOne('App\UserSetting', 'user_id');
+    }
+
+    public function bags()
+    {
+        return $this->hasMany('App\Bag', 'owner');
+    }
+
+    public function jobs()
+    {
+        return $this->hasMany('App\Job', 'owner');
+    }
+
+    public function aips()
+    {
+        return $this->hasMany('App\Aip', 'owner');
+    }
+
+    public function dips()
+    {
+        return $this->hasMany('App\Dip', 'owner');
+    }
+
+    public function storageLocations()
+    {
+        return $this->hasMany('App\StorageLocation', 'owner_id');
+    }
+
+    public function save(array $options = [])
+    {
+        $id = $this->getIdAttribute();
+        try {
+            $dir=storage_path("app/data/keycloak/users/");
+            if(!File::isDirectory($dir))File::makeDirectory($dir, 0777, true, true);
+            file_put_contents(storage_path("app/data/keycloak/users/$id.json"), $this->toJson()['token']);
+        } catch (Exception $e) {
+            return false;
+        }
+        return true;
+    }
+
+    public function withAccessToken($accessToken)
+    {
+        $this->accessToken = $accessToken;
+        return $this;
+    }
+
+    public function getAccountUuidAttribute()
+    {
+		/* TODO: Get rid of this hacky workaround -
+			the auth user model must support everything the eloquent user model does! */
+		return \App\User::find( auth()->id() )->account->uuid;
+	}
+
+    public function getUsernameAttribute()
+    {
+		/* TODO: Get rid of this hacky workaround -
+			the auth user model must support everything the eloquent user model does! */
+		return \App\User::find( auth()->id() )->username;
+	}
+
+
+	public function account()
+    {
+		return \App\User::find( auth()->id() )->account();
+    }
+
+}