SOAP API: Return an empty result when the page is outside the filter

Rather than return the last page when an out of bounds page is requested, return no issues. This allows clients to find out when there are no more issues for a specific filter. Fixes #12991 : mc_filter_get_issues returns incorrect results for page_number > page_count
mantisbt · May 19, 2011 · c70ff52 · c70ff52
1 parent a744e69
commit c70ff52
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 1 deletion.
diff --git a/api/soap/mc_filter_api.php b/api/soap/mc_filter_api.php
@@ -58,6 +58,7 @@ function mc_filter_get_issues( $p_username, $p_password, $p_project_id, $p_filte
 		return mci_soap_fault_access_denied( $t_user_id );
 	}
 
+	$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
 	$t_page_count = 0;
 	$t_bug_count = 0;
 	$t_filter = filter_db_get_filter( $p_filter_id );
@@ -71,6 +72,10 @@ function mc_filter_get_issues( $p_username, $p_password, $p_project_id, $p_filte
 	$t_result = array();
 	$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, $t_filter, $p_project_id );
 
+	// the page number was moved back, so we have exceeded the actual page number, see bug #12991
+	if ( $t_orig_page_number > $p_page_number )
+	    return $t_result;	
+
 	foreach( $t_rows as $t_issue_data ) {
 		$t_result[] = mci_issue_data_as_array( $t_issue_data, $t_user_id, $t_lang );
 	}
@@ -97,6 +102,7 @@ function mc_filter_get_issue_headers( $p_username, $p_password, $p_project_id, $
 		return mci_soap_fault_access_denied( $t_user_id );
 	}
 
+	$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
 	$t_page_count = 0;
 	$t_bug_count = 0;
 	$t_filter = filter_db_get_filter( $p_filter_id );
@@ -110,6 +116,10 @@ function mc_filter_get_issue_headers( $p_username, $p_password, $p_project_id, $
 	$t_result = array();
 	$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, $t_filter, $p_project_id );
 
+	// the page number was moved back, so we have exceeded the actual page number, see bug #12991
+	if ( $t_orig_page_number > $p_page_number )
+	    return $t_result;	
+
 	foreach( $t_rows as $t_issue_data ) {
 		$t_id = $t_issue_data->id;
 

diff --git a/api/soap/mc_project_api.php b/api/soap/mc_project_api.php
@@ -22,11 +22,17 @@ function mc_project_get_issues( $p_username, $p_password, $p_project_id, $p_page
 		return mci_soap_fault_access_denied( $t_user_id );
 	}
 
+	$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
 	$t_page_count = 0;
 	$t_bug_count = 0;
 
 	$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, null, $p_project_id );
+
 	$t_result = array();
+
+	// the page number was moved back, so we have exceeded the actual page number, see bug #12991
+	if ( $t_orig_page_number > $p_page_number )
+	    return $t_result;	
 
 	foreach( $t_rows as $t_issue_data ) {
 		$t_result[] = mci_issue_data_as_array( $t_issue_data, $t_user_id, $t_lang );
@@ -855,12 +861,17 @@ function mc_project_get_issue_headers( $p_username, $p_password, $p_project_id,
 	if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
 		return mci_soap_fault_access_denied( $t_user_id );
 	}
-
+
+	$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
 	$t_page_count = 0;
 	$t_bug_count = 0;
 
 	$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, null, $p_project_id );
 	$t_result = array();
+
+	// the page number was moved back, so we have exceeded the actual page number, see bug #12991
+	if ( $t_orig_page_number > $p_page_number )
+	    return $t_result;
 
 	foreach( $t_rows as $t_issue_data ) {
 		$t_id = $t_issue_data->id;

diff --git a/tests/soap/FilterTest.php b/tests/soap/FilterTest.php
@@ -182,6 +182,33 @@ public function testGetProjectIssuesWithoutCategory() {
 
 		$this->assertEquals( $issueId, $projectIssues[0]->id, "id" );
 	}
+
+	/**
+	 * Verifies that after the last page no more issues are being returned
+	 */
+	public function testGetIssueHeadersPaged() {
+
+	    $issue = $this->getIssueToAdd('FilterTest.getIssueHeadersPaged');
+	    $issueId = $this->client->mc_issue_add($this->userName, $this->password, $issue);
+	    $this->deleteAfterRun($issueId);
+
+	    self::assertEquals(1, count($this->client->mc_project_get_issue_headers($this->userName, $this->password, $this->getProjectId(),1, 1 )));
+	    self::assertEquals(0, count($this->client->mc_project_get_issue_headers($this->userName, $this->password, $this->getProjectId(),2, 1 )));
+	}
+
+	/**
+	 * Verifies that after the last page no more issues are being returned
+	 */
+	public function testGetIssuesPaged() {
+
+	    $issue = $this->getIssueToAdd('FilterTest.getIssuesPaged');
+	    $issueId = $this->client->mc_issue_add($this->userName, $this->password, $issue);
+	    $this->deleteAfterRun($issueId);
+
+	    self::assertEquals(1, count($this->client->mc_project_get_issues($this->userName, $this->password, $this->getProjectId(),1, 1 )));
+	    self::assertEquals(0, count($this->client->mc_project_get_issues($this->userName, $this->password, $this->getProjectId(),2, 1 )));
+	}
+
 
 	/**
 	 *