Refactor Model Architecture

.php_cs

@@ -1,35 +1,37 @@
 <?php
+
 $finder = array_reduce(
-    [
-        __DIR__ . '/app/',
-        __DIR__ . '/database/',
-        __DIR__ . '/resources/',
-        __DIR__ . '/routes/',
-        __DIR__ . '/tests/',
-    ],
-    function (PhpCsFixer\Finder $finder, $dir) {
-        return $finder->in($dir);
-    },
-    PhpCsFixer\Finder::create()->ignoreUnreadableDirs()
+	[
+		__DIR__ . '/app/',
+		__DIR__ . '/database/',
+		__DIR__ . '/resources/',
+		__DIR__ . '/routes/',
+		__DIR__ . '/tests/',
+	],
+	function (PhpCsFixer\Finder $finder, $dir) {
+		return $finder->in($dir);
+	},
+	PhpCsFixer\Finder::create()->ignoreUnreadableDirs()
 )->notName('*.blade.php');
 $rules = [
-    '@Symfony' => true,
-    'align_multiline_comment' => true,
-    'array_indentation' => true,
-    'backtick_to_shell_exec' => true,
-    'increment_style' => ['style' => 'post'],
-    'indentation_type' => true,
-    'multiline_comment_opening_closing' => true,
-    'no_php4_constructor' => true,
-    'phpdoc_no_empty_return' => false,
-    'single_blank_line_at_eof' => false,
-    'yoda_style' => false,
-    'concat_space' => ['spacing' => 'one'],
-    'no_superfluous_phpdoc_tags' => false,
+	'@Symfony' => true,
+	'align_multiline_comment' => true,
+	'array_indentation' => true,
+	'backtick_to_shell_exec' => true,
+	'increment_style' => ['style' => 'post'],
+	'indentation_type' => true,
+	'multiline_comment_opening_closing' => true,
+	'no_php4_constructor' => true,
+	'phpdoc_no_empty_return' => false,
+	'single_blank_line_at_eof' => false,
+	'yoda_style' => false,
+	'concat_space' => ['spacing' => 'one'],
+	'no_superfluous_phpdoc_tags' => false,
 ];
-return PhpCsFixer\Config::create()
-    ->setRiskyAllowed(true)
-    ->setRules($rules)
-    ->setIndent("\t")
-    ->setLineEnding("\n")
-    ->setFinder($finder);
+
+return (new PhpCsFixer\Config())
+	->setRiskyAllowed(true)
+	->setRules($rules)
+	->setIndent("\t")
+	->setLineEnding("\n")
+	->setFinder($finder);

app/Actions/Album/Archive.php

@@ -9,7 +9,7 @@
 use App\Models\Configs;
 use App\Models\Logs;
 use App\Models\Photo;
-use Illuminate\Support\Facades\Storage;
+use App\Models\SizeVariant;
 use Symfony\Component\HttpFoundation\HeaderUtils;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use ZipStream\ZipStream;
@@ -155,16 +155,15 @@ private function compress_album($photos_sql, $dir_name, &$dirs, $parent_dir, $al
 
 			$is_raw = ($photo->type == 'raw');
 
-			$prefix_url = $is_raw ? 'raw/' : 'big/';
-			$url = Storage::path($prefix_url . $photo->url);
+			$fullPath = $photo->size_variants->getSizeVariant(SizeVariant::ORIGINAL)->full_path;
 			// Check if readable
-			if (!@is_readable($url)) {
-				Logs::error(__METHOD__, __LINE__, 'Original photo missing: ' . $url);
+			if (!@is_readable($fullPath)) {
+				Logs::error(__METHOD__, __LINE__, 'Original photo missing: ' . $fullPath);
 				continue;
 			}
 
 			// Get extension of image
-			$extension = Helpers::getExtension($url, false);
+			$extension = Helpers::getExtension($fullPath, false);
 
 			// Set title for photo
 			$title = str_replace($this->badChars, '', $photo->title);
@@ -198,7 +197,7 @@ private function compress_album($photos_sql, $dir_name, &$dirs, $parent_dir, $al
 			set_time_limit(ini_get('max_execution_time'));
 
 			// add a file named 'some_image.jpg' from a local file 'path/to/image.jpg'
-			$zip->addFileFromPath($dir_name . '/' . $file, $url);
+			$zip->addFileFromPath($dir_name . '/' . $file, $fullPath);
 		} // foreach ($photos)
 
 		// Recursively compress subalbums

app/Actions/Album/Create.php

@@ -2,14 +2,11 @@
 
 namespace App\Actions\Album;
 
-use App\Actions\Album\Extensions\StoreAlbum;
 use App\Facades\AccessControl;
 use App\Models\Album;
 
 class Create extends Action
 {
-	use StoreAlbum;
-
 	/**
 	 * @param string $albumID
 	 *
@@ -20,8 +17,11 @@ public function create(string $title, int $parent_id): Album
 		$album = $this->albumFactory->makeFromTitle($title);
 
 		$this->set_parent($album, $parent_id);
+		if (!$album->save()) {
+			throw new \RuntimeException('could not persist album to DB');
+		}
 
-		return $this->store_album($album);
+		return $album;
 	}
 
 	/**

app/Actions/Album/CreateTag.php

@@ -2,21 +2,18 @@
 
 namespace App\Actions\Album;
 
-use App\Actions\Album\Extensions\StoreAlbum;
 use App\Facades\AccessControl;
 use App\Models\Album;
 
 class CreateTag extends Action
 {
-	use StoreAlbum;
-
 	/**
 	 * Create a new smart album based on tags.
 	 *
 	 * @param string $title
 	 * @param string $show_tags
 	 *
-	 * @return Album|Response
+	 * @return Album
 	 */
 	public function create(string $title, string $show_tags): Album
 	{
@@ -27,7 +24,10 @@ public function create(string $title, string $show_tags): Album
 
 		$album->smart = true;
 		$album->showtags = $show_tags;
+		if (!$album->save()) {
+			throw new \RuntimeException('could not persist album to DB');
+		}
 
-		return $this->store_album($album);
+		return $album;
 	}
 }

app/Actions/Album/Delete.php

@@ -19,10 +19,13 @@ public function do(string $albumIDs): bool
 		$no_error = true;
 		// root = unsorted
 		if ($albumIDs == 'unsorted') {
-			$photos = Photo::OwnedBy(AccessControl::id())->where('album_id', '=', null)->get();
+			$photos = Photo::OwnedBy(AccessControl::id())
+				->with(['size_variants_raw', 'size_variants_raw.sym_links'])
+				->where('album_id', '=', null)
+				->get();
 
+			/** @var Photo $photo */
 			foreach ($photos as $photo) {
-				$no_error &= $photo->predelete();
 				$no_error &= $photo->delete();
 			}
 
@@ -31,7 +34,9 @@ public function do(string $albumIDs): bool
 
 		$albums = Album::whereIn('id', explode(',', $albumIDs))->get();
 
-		$sqlPhoto = Photo::leftJoin('albums', 'photos.album_id', '=', 'albums.id')
+		$sqlPhoto = Photo::query()
+			->with(['size_variants_raw', 'size_variants_raw.sym_links'])
+			->leftJoin('albums', 'photos.album_id', '=', 'albums.id')
 			->select('photos.*');
 
 		foreach ($albums as $album) {
@@ -40,8 +45,8 @@ public function do(string $albumIDs): bool
 		}
 
 		$photos = $sqlPhoto->get();
+		/** @var Photo $photo */
 		foreach ($photos as $photo) {
-			$no_error &= $photo->predelete();
 			$no_error &= $photo->delete();
 		}
 

app/Actions/Album/Extensions/LocationData.php

@@ -2,7 +2,7 @@
 
 namespace App\Actions\Album\Extensions;
 
-use App\ModelFunctions\SymLinkFunctions;
+use App\Models\Photo;
 use Illuminate\Database\Eloquent\Builder;
 
 trait LocationData
@@ -17,26 +17,17 @@ trait LocationData
 	 */
 	public function photosLocationData(Builder $photos_sql)
 	{
-		$symLinkFunctions = resolve(SymLinkFunctions::class);
-
 		$return_photos = [];
 		$photo_counter = 0;
 		$photos = $photos_sql
 			->whereNotNull('latitude')
 			->whereNotNull('longitude')
-			->with('album')
+			->with(['album', 'size_variants_raw', 'size_variants_raw.sym_links'])
 			->get();
 
-		/*
-		* @var Photo
-		*/
+		/** @var Photo $photo_model */
 		foreach ($photos as $photo_model) {
-			$photo = $photo_model->toReturnArray();
-			$symLinkFunctions->getUrl($photo_model, $photo);
-
-			// Add to return
-			$return_photos[$photo_counter] = $photo;
-
+			$return_photos[$photo_counter] = $photo_model->toArray();
 			$photo_counter++;
 		}
 

app/Actions/Album/Photos.php

@@ -2,23 +2,12 @@
 
 namespace App\Actions\Album;
 
-use App\Facades\AccessControl;
-use App\ModelFunctions\SymLinkFunctions;
 use App\Models\Album;
 use App\Models\Configs;
 use App\Models\Photo;
-use Illuminate\Database\Eloquent\Collection;
 
 class Photos
 {
-	/** @var SymLinkFunctions */
-	private $symLinkFunctions;
-
-	public function __construct(SymLinkFunctions $symLinkFunctions)
-	{
-		$this->symLinkFunctions = $symLinkFunctions;
-	}
-
 	/**
 	 * take a $photo_sql query and return an array containing their pictures.
 	 *
@@ -29,7 +18,7 @@ public function __construct(SymLinkFunctions $symLinkFunctions)
 	public function get(Album $album): array
 	{
 		[$sortingCol, $sortingOrder] = $album->get_sort();
-		$photos_sql = $album->get_photos();
+		$photos_sql = $album->get_photos()->with(['size_variants_raw', 'size_variants_raw.sym_links']);
 
 		$previousPhotoID = '';
 		$return_photos = [];
@@ -66,13 +55,7 @@ public function get(Album $album): array
 		/** @var Photo $photo_model */
 		foreach ($photos as $photo_model) {
 			// Turn data from the database into a front-end friendly format
-			$photo = $photo_model->toReturnArray();
-			$photo['license'] = $photo_model->get_license($album->get_license());
-
-			$this->symLinkFunctions->getUrl($photo_model, $photo);
-			if (!AccessControl::is_current_user($photo_model->owner_id) && !$album->is_full_photo_visible()) {
-				$photo_model->downgrade($photo);
-			}
+			$photo = $photo_model->toArray();
 
 			// Set previous and next photoID for navigation purposes
 			$photo['previousPhoto'] = $previousPhotoID;

app/Actions/Import/Exec.php

@@ -2,9 +2,11 @@
 
 namespace App\Actions\Import;
 
-use App\Actions\Album\Create;
-use App\Actions\Import\Extensions\ImportPhoto;
+use App\Actions\Album\Create as AlbumCreate;
+use App\Actions\Photo\Create as PhotoCreate;
 use App\Actions\Photo\Extensions\Constants;
+use App\Actions\Photo\Extensions\SourceFileInfo;
+use App\Actions\Photo\Strategies\ImportMode;
 use App\Exceptions\PhotoResyncedException;
 use App\Exceptions\PhotoSkippedException;
 use App\Facades\Helpers;
@@ -17,9 +19,9 @@
 
 class Exec
 {
-	use ImportPhoto;
 	use Constants;
 
+	// TODO: Refactor this and use `ImportMode` instead of four boolean properties
 	public $skip_duplicates = false;
 	public $resync_metadata = false;
 	public $delete_imported;
@@ -243,7 +245,22 @@ public function do(
 			if (@exif_imagetype($file) !== false || in_array(strtolower($extension), $this->validExtensions, true) || $is_raw) {
 				// Photo or Video
 				try {
-					if ($this->photo($file, $this->delete_imported, $this->import_via_symlink, $albumID, $this->skip_duplicates, $this->resync_metadata) === false) {
+					// TODO: Refactor this, rationale see below
+					// This is not the way how `PhotoCreate` is supposed
+					// to be used.
+					// Actually, an instance of the class should only
+					// be created once using a single instance of
+					// `ImportMode` and then `PhotoCreate::add` should
+					// be called for each file.
+					$photoCreate = new PhotoCreate(new ImportMode(
+						$this->delete_imported,
+						$this->import_via_symlink,
+						$this->skip_duplicates,
+						$this->resync_metadata
+					));
+					if (
+						$photoCreate->add(SourceFileInfo::createForLocalFile($file), $albumID) == null
+					) {
 						$this->status_error($file, 'Could not import file');
 						Logs::error(__METHOD__, __LINE__, 'Could not import file (' . $file . ')');
 					}
@@ -273,7 +290,7 @@ public function do(
 					->first();
 			}
 			if ($album === null) {
-				$create = resolve(Create::class);
+				$create = resolve(AlbumCreate::class);
 				$album = $create->create(basename($dir), $albumID);
 				// this actually should not fail.
 				if ($album === false) {