Hotfix (#2098)

**3.1.8 Hotfix update** - API developments -- Fix bug associated with displaying all media. Previous output was limited to first 200 records only -- Add limit and offset variables to display all media -- Add filters to display all media endpoint: tid filter, includeSynonyms, includeChildren - Out of bounds hyperlink within occurrence editor. Resolves #2099 Co-authored-by: Greg Post <[email protected]> Co-authored-by: Mark <[email protected]>
BioKIC · Jan 24, 2025 · 3d8bd42 · 3d8bd42
1 parent 97f8a9c
commit 3d8bd42
Show file tree

Hide file tree

Showing 13 changed files with 222 additions and 41 deletions.
diff --git a/api/app/Http/Controllers/CollectionController.php b/api/app/Http/Controllers/CollectionController.php
@@ -44,7 +44,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),

diff --git a/api/app/Http/Controllers/InventoryController.php b/api/app/Http/Controllers/InventoryController.php
@@ -28,7 +28,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),
@@ -111,7 +111,7 @@ public function showOneInventory($id, Request $request){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),

diff --git a/api/app/Http/Controllers/MediaController.php b/api/app/Http/Controllers/MediaController.php
@@ -3,8 +3,10 @@
 namespace App\Http\Controllers;
 
 use App\Models\Media;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Http\Request;
 use Illuminate\Support\Str;
+use App\Http\Controllers\TaxonomyController;
 
 class MediaController extends Controller{
 
@@ -34,9 +36,44 @@ public function __construct(){
 	 *	 path="/api/v2/media",
 	 *	 operationId="showAllMedia",
 	 *	 tags={""},
+	 *	 @OA\Parameter(
+	 *		 name="tid",
+	 *		 in="query",
+	 *		 description="Display media filtered by target taxon ID (PK key of taxon)",
+	 *		 required=false,
+	 *		 @OA\Schema(type="integer")
+	 *	 ),
+	 *	 @OA\Parameter(
+	 *		 name="includeSynonyms",
+	 *		 in="query",
+	 *		 description="Include media linked to synonyms of target taxon (0 = false, 1 = true)",
+	 *		 required=false,
+	 *		 @OA\Schema(type="integer", default=0)
+	 *	 ),
+	 *	 @OA\Parameter(
+	 *		 name="includeChildren",
+	 *		 in="query",
+	 *		 description="Include media linked to direct children of target taxon (0 = false, 1 = true)",
+	 *		 required=false,
+	 *		 @OA\Schema(type="integer", default=0)
+	 *	 ),
+	 *	 @OA\Parameter(
+	 *		 name="limit",
+	 *		 in="query",
+	 *		 description="Controls the number of results in the page.",
+	 *		 required=false,
+	 *		 @OA\Schema(type="integer", default=100)
+	 *	 ),
+	 *	 @OA\Parameter(
+	 *		 name="offset",
+	 *		 in="query",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
+	 *		 required=false,
+	 *		 @OA\Schema(type="integer", default=0)
+	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="200",
-	 *		 description="Returns list of media records",
+	 *		 description="Success: Returns list of media records",
 	 *		 @OA\JsonContent()
 	 *	 ),
 	 *	 @OA\Response(
@@ -45,8 +82,44 @@ public function __construct(){
 	 *	 ),
 	 * )
 	 */
-	public function showAllMedia(){
-		return response()->json(Media::skip(0)->take(100)->get());
+	public function showAllMedia(Request $request){
+
+		$this->validate($request, [
+			'tid' => 'integer',
+			'includeSynonyms' => 'integer',
+			'includeChildren' => 'integer',
+			'limit' => 'integer',
+			'offset' => 'integer'
+		]);
+		$tid = $request->input('tid');
+		$includeSynonyms = $request->input('includeSynonyms');
+		$includeChildren = $request->input('includeChildren');
+		$limit = $request->input('limit',100);
+		$offset = $request->input('offset',0);
+
+		$mediaModel = Media::query();
+		if($tid){
+			$tidArr = array($tid);
+			if($includeSynonyms){
+				$tidArr = TaxonomyController::getSynonyms($tid);
+			}
+			if($includeChildren){
+				$tidArr = array_merge($tidArr, TaxonomyController::getChildren($tid));
+			}
+			$mediaModel->whereIn('tid', $tidArr);
+		}
+		$fullCnt = $mediaModel->count();
+		$result = $mediaModel->skip($offset)->take($limit)->get();
+
+		$eor = false;
+		$retObj = [
+			'offset' => (int)$offset,
+			'limit' => (int)$limit,
+			'endOfRecords' => $eor,
+			'count' => $fullCnt,
+			'results' => $result
+		];
+		return response()->json($retObj);
 	}
 
 	/**
@@ -63,7 +136,7 @@ public function showAllMedia(){
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="200",
-	 *		 description="Returns single media record",
+	 *		 description="Success: Returns single media record",
 	 *		 @OA\JsonContent(type="application/json")
 	 *	 ),
 	 *	 @OA\Response(
@@ -233,7 +306,7 @@ public function showOneMedia($id){
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="201",
-	 *		 description="Returns JSON object of the of media record that was created"
+	 *		 description="Success: Returns JSON object of the of media record that was created"
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="400",
@@ -424,7 +497,7 @@ public function insert(Request $request){
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="200",
-	 *		 description="Returns full JSON object of the of media record that was edited"
+	 *		 description="Success: Returns full JSON object of the of media record that was edited"
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="400",
@@ -472,7 +545,7 @@ public function update($id, Request $request){
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="204",
-	 *		 description="Record deleted successfully"
+	 *		 description="Success: Record deleted successfully"
 	 *	 ),
 	 *	 @OA\Response(
 	 *		 response="400",
@@ -496,6 +569,7 @@ public function delete($id, Request $request){
 		return response()->json(['status' => 'failure', 'error' => 'Unauthorized'], 401);
 	}
 
+	//Support functions
 	private function adjustInputData(&$data){
 		if(!empty($data['mediumUrl'])){
 			//remap mediumUrl to url field

diff --git a/api/app/Http/Controllers/OccurrenceAnnotationController.php b/api/app/Http/Controllers/OccurrenceAnnotationController.php
@@ -73,7 +73,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),

diff --git a/api/app/Http/Controllers/OccurrenceController.php b/api/app/Http/Controllers/OccurrenceController.php
@@ -126,7 +126,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),

diff --git a/api/app/Http/Controllers/TaxonomyController.php b/api/app/Http/Controllers/TaxonomyController.php
@@ -31,7 +31,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),
@@ -76,7 +76,7 @@ public function showAllTaxa(Request $request){
 	 *	 @OA\Parameter(
 	 *		 name="taxon",
 	 *		 in="query",
-	 *		 description="Taxon searh term",
+	 *		 description="Taxon search term",
 	 *		 required=true,
 	 *		 @OA\Schema(type="string")
 	 *	 ),
@@ -101,7 +101,7 @@ public function showAllTaxa(Request $request){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),
@@ -241,7 +241,7 @@ public function showOneTaxon($id, Request $request){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),
@@ -282,4 +282,24 @@ public function showAllDescriptions($id, Request $request){
 		return response()->json($retObj);
 	}
 
+	//Support functions
+	public static function getSynonyms(Int $tid){
+		$synonymResult = DB::table('taxstatus as ts')
+		->join('taxstatus as s', 'ts.tidaccepted', '=', 's.tidaccepted')
+		->where('ts.tid', $tid)->where('ts.taxauthid', 1)->where('s.taxauthid', 1)->pluck('s.tid');
+		return $synonymResult->toArray();
+	}
+
+	public static function getChildren(Int $tid){
+		//Direct accepted children only
+		$childrenResult = DB::table('taxstatus as c')
+		->join('taxstatus as a', 'c.parenttid', '=', 'a.tidaccepted')
+		->where('a.tid', $tid)->where('c.taxauthid', 1)->where('a.taxauthid', 1)->whereColumn('c.tid', 'c.tidaccepted')->pluck('c.tid');
+		/*
+		SELECT c.tid
+		FROM taxstatus c INNER JOIN taxstatus a ON c.parenttid = a.tidaccepted
+		WHERE a.tid = 61943 AND c.taxauthid = 1 AND a.taxauthid = 1 AND c.tid = c.tidaccepted;
+		*/
+		return $childrenResult->toArray();
+	}
 }
diff --git a/api/app/Http/Controllers/TaxonomyDescriptionController.php b/api/app/Http/Controllers/TaxonomyDescriptionController.php
@@ -35,7 +35,7 @@ public function __construct(){
 	 *	 @OA\Parameter(
 	 *		 name="offset",
 	 *		 in="query",
-	 *		 description="Determines the offset for the search results. A limit of 200 and offset of 100, will get the third page of 100 results.",
+	 *		 description="Determines the starting point for the search results. A limit of 100 and offset of 200, will display 100 records starting the 200th record.",
 	 *		 required=false,
 	 *		 @OA\Schema(type="integer", default=0)
 	 *	 ),

diff --git a/api/app/Models/Media.php b/api/app/Models/Media.php
@@ -26,6 +26,10 @@ public function occurrence() {
 		return $this->belongsTo(Occurrence::class, 'occid', 'occid');
 	}
 
+	public function Taxonomy() {
+		return $this->belongsTo(Taxonomy::class, 'tid', 'tid');
+	}
+
 	//Accessor functions
 	public function getUrlAttribute($value){
 		if(substr($value, 0, 1) == '/') $value = $this->serverDomain . $value;