Merge pull request #14630 from nextcloud/backport/14629/stable31

nickvergessen · web-flow · commit dcd757c4e275 · 2025-03-12T08:15:01.000+01:00
[stable31] fix(calls): Fix displayname when exporting call participants
diff --git a/lib/Controller/CallController.php b/lib/Controller/CallController.php
@@ -121,8 +121,8 @@ public function getPeersForCall(): DataResponse {
 	 *
 	 * Required capability: `download-call-participants`
 	 *
-	 * @param 'csv'|'pdf' $format Download format
-	 * @return DataDownloadResponse<Http::STATUS_OK, 'text/csv'|'application/pdf', array{}>|Response<Http::STATUS_BAD_REQUEST, array{}>
+	 * @param 'csv' $format Download format
+	 * @return DataDownloadResponse<Http::STATUS_OK, 'text/csv', array{}>|Response<Http::STATUS_BAD_REQUEST, array{}>
 	 *
 	 * 200: List of participants in the call downloaded in the requested format
 	 * 400: No call in progress
@@ -141,13 +141,8 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa
 			return new Response(Http::STATUS_BAD_REQUEST);
 		}
 
-		if ($format !== 'csv' && $format !== 'pdf') {
-			// Unsupported format
-			return new Response(Http::STATUS_BAD_REQUEST);
-		}
-
 		if ($format !== 'csv') {
-			// FIXME Remove once pdf was implemented.
+			// Unsupported format
 			return new Response(Http::STATUS_BAD_REQUEST);
 		}
 
@@ -166,12 +161,12 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa
 			} elseif ($participant->getAttendee()->getActorType() === Attendee::ACTOR_USERS) {
 				$email = $this->userManager->get($participant->getAttendee()->getActorId())?->getEMailAddress() ?? '';
 			}
-			fputcsv($output, [
+			fputcsv($output, array_map([$this, 'escapeFormulae'], [
 				$participant->getAttendee()->getDisplayName(),
 				$email,
 				$participant->getAttendee()->getActorType(),
 				$participant->getAttendee()->getActorId(),
-			], escape: '');
+			]), escape: '');
 		}
 
 		fseek($output, 0);
@@ -198,6 +193,13 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa
 		return new DataDownloadResponse(stream_get_contents($output), $fileName, 'text/csv');
 	}
 
+	protected function escapeFormulae(string $value): string {
+		if (preg_match('/^[=+\-@\t\r]/', $value)) {
+			return "'" . $value;
+		}
+		return $value;
+	}
+
 	/**
 	 * Join a call
 	 *
diff --git a/openapi-full.json b/openapi-full.json
@@ -4785,8 +4785,7 @@
                             "type": "string",
                             "default": "csv",
                             "enum": [
-                                "csv",
-                                "pdf"
+                                "csv"
                             ]
                         }
                     },
@@ -4810,12 +4809,6 @@
                                     "type": "string",
                                     "format": "binary"
                                 }
-                            },
-                            "application/pdf": {
-                                "schema": {
-                                    "type": "string",
-                                    "format": "binary"
-                                }
                             }
                         }
                     },
diff --git a/openapi.json b/openapi.json
@@ -4690,8 +4690,7 @@
                             "type": "string",
                             "default": "csv",
                             "enum": [
-                                "csv",
-                                "pdf"
+                                "csv"
                             ]
                         }
                     },
@@ -4715,12 +4714,6 @@
                                     "type": "string",
                                     "format": "binary"
                                 }
-                            },
-                            "application/pdf": {
-                                "schema": {
-                                    "type": "string",
-                                    "format": "binary"
-                                }
                             }
                         }
                     },
diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -3660,7 +3660,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description Download format */
-                format?: "csv" | "pdf";
+                format?: "csv";
             };
             header: {
                 /** @description Required to be true for the API request to pass */
@@ -3681,7 +3681,6 @@ export interface operations {
                 };
                 content: {
                     "text/csv": string;
-                    "application/pdf": string;
                 };
             };
             /** @description No call in progress */
diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -3142,7 +3142,7 @@ export interface operations {
         parameters: {
             query?: {
                 /** @description Download format */
-                format?: "csv" | "pdf";
+                format?: "csv";
             };
             header: {
                 /** @description Required to be true for the API request to pass */
@@ -3163,7 +3163,6 @@ export interface operations {
                 };
                 content: {
                     "text/csv": string;
-                    "application/pdf": string;
                 };
             };
             /** @description No call in progress */
diff --git a/tests/integration/features/callapi/public.feature b/tests/integration/features/callapi/public.feature
@@ -95,17 +95,18 @@ Feature: callapi/public
     And user "guest" joins call "room" with 200 (v4)
     Then user "participant1" sees 2 peers in call "room" with 200 (v4)
     And user "guest" sees 2 peers in call "room" with 200 (v4)
+    And guest "guest" sets name to "=1+1" in room "room" with 200 (v1)
     And invoking occ with "user:setting participant1 settings email participant1@example.tld"
     And user "participant2" downloads call participants from "room" as "csv" with 403 (v4)
     And user "participant1" downloads call participants from "room" as "csv" with 200 (v4)
       | name                     | email                    | type   | identifier   |
       | participant1-displayname | participant1@example.tld | users  | participant1 |
-      |                          |                          | guests | guest1       |
+      | '=1+1                    |                          | guests | guest1       |
     Then user "guest" leaves call "room" with 200 (v4)
     And user "participant1" downloads call participants from "room" as "csv" with 200 (v4)
       | name                     | email                    | type   | identifier   |
       | participant1-displayname | participant1@example.tld | users  | participant1 |
-      |                          |                          | guests | guest1       |
+      | '=1+1                    |                          | guests | guest1       |
     And invoking occ with "user:setting participant1 settings email --delete"
     Then user "participant1" sees 1 peers in call "room" with 200 (v4)
     And user "guest" sees 1 peers in call "room" with 200 (v4)

Original file line number	Diff line number	Diff line change
`@@ -121,8 +121,8 @@ public function getPeersForCall(): DataResponse {`
`121`	`121`	`*`
`122`	`122`	* Required capability: `download-call-participants`
`123`	`123`	`*`
`124`		`- * @param 'csv'\|'pdf' $format Download format`
`125`		`- * @return DataDownloadResponse<Http::STATUS_OK, 'text/csv'\|'application/pdf', array{}>\|Response<Http::STATUS_BAD_REQUEST, array{}>`
	`124`	`+ * @param 'csv' $format Download format`
	`125`	`+ * @return DataDownloadResponse<Http::STATUS_OK, 'text/csv', array{}>\|Response<Http::STATUS_BAD_REQUEST, array{}>`
`126`	`126`	`*`
`127`	`127`	`* 200: List of participants in the call downloaded in the requested format`
`128`	`128`	`* 400: No call in progress`
`@@ -141,13 +141,8 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa`
`141`	`141`	`return new Response(Http::STATUS_BAD_REQUEST);`
`142`	`142`	`}`
`143`	`143`
`144`		`- if ($format !== 'csv' && $format !== 'pdf') {`
`145`		`- // Unsupported format`
`146`		`- return new Response(Http::STATUS_BAD_REQUEST);`
`147`		`- }`
`148`		`-`
`149`	`144`	`if ($format !== 'csv') {`
`150`		`- // FIXME Remove once pdf was implemented.`
	`145`	`+ // Unsupported format`
`151`	`146`	`return new Response(Http::STATUS_BAD_REQUEST);`
`152`	`147`	`}`
`153`	`148`
`@@ -166,12 +161,12 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa`
`166`	`161`	`} elseif ($participant->getAttendee()->getActorType() === Attendee::ACTOR_USERS) {`
`167`	`162`	`$email = $this->userManager->get($participant->getAttendee()->getActorId())?->getEMailAddress() ?? '';`
`168`	`163`	`}`
`169`		`- fputcsv($output, [`
	`164`	`+ fputcsv($output, array_map([$this, 'escapeFormulae'], [`
`170`	`165`	`$participant->getAttendee()->getDisplayName(),`
`171`	`166`	`$email,`
`172`	`167`	`$participant->getAttendee()->getActorType(),`
`173`	`168`	`$participant->getAttendee()->getActorId(),`
`174`		`- ], escape: '');`
	`169`	`+ ]), escape: '');`
`175`	`170`	`}`
`176`	`171`
`177`	`172`	`fseek($output, 0);`
`@@ -198,6 +193,13 @@ public function downloadParticipantsForCall(string $format = 'csv'): DataDownloa`
`198`	`193`	`return new DataDownloadResponse(stream_get_contents($output), $fileName, 'text/csv');`
`199`	`194`	`}`
`200`	`195`
	`196`	`+ protected function escapeFormulae(string $value): string {`
	`197`	`+ if (preg_match('/^[=+\-@\t\r]/', $value)) {`
	`198`	`+ return "'" . $value;`
	`199`	`+ }`
	`200`	`+ return $value;`
	`201`	`+ }`
	`202`	`+`
`201`	`203`	`/**`
`202`	`204`	`* Join a call`
`203`	`205`	`*`
Original file line number	Diff line number	Diff line change
`@@ -4785,8 +4785,7 @@`
`4785`	`4785`	`"type": "string",`
`4786`	`4786`	`"default": "csv",`
`4787`	`4787`	`"enum": [`
`4788`		`- "csv",`
`4789`		`- "pdf"`
	`4788`	`+ "csv"`
`4790`	`4789`	`]`
`4791`	`4790`	`}`
`4792`	`4791`	`},`
`@@ -4810,12 +4809,6 @@`
`4810`	`4809`	`"type": "string",`
`4811`	`4810`	`"format": "binary"`
`4812`	`4811`	`}`
`4813`		`- },`
`4814`		`- "application/pdf": {`
`4815`		`- "schema": {`
`4816`		`- "type": "string",`
`4817`		`- "format": "binary"`
`4818`		`- }`
`4819`	`4812`	`}`
`4820`	`4813`	`}`
`4821`	`4814`	`},`
Original file line number	Diff line number	Diff line change
`@@ -4690,8 +4690,7 @@`
`4690`	`4690`	`"type": "string",`
`4691`	`4691`	`"default": "csv",`
`4692`	`4692`	`"enum": [`
`4693`		`- "csv",`
`4694`		`- "pdf"`
	`4693`	`+ "csv"`
`4695`	`4694`	`]`
`4696`	`4695`	`}`
`4697`	`4696`	`},`
`@@ -4715,12 +4714,6 @@`
`4715`	`4714`	`"type": "string",`
`4716`	`4715`	`"format": "binary"`
`4717`	`4716`	`}`
`4718`		`- },`
`4719`		`- "application/pdf": {`
`4720`		`- "schema": {`
`4721`		`- "type": "string",`
`4722`		`- "format": "binary"`
`4723`		`- }`
`4724`	`4717`	`}`
`4725`	`4718`	`}`
`4726`	`4719`	`},`