Subsonic API: better parameter/error handling

src/api/subsonic/SubsonicResource.cpp

@@ -160,20 +160,29 @@ getParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& pa
 	return it->second.front();
 }
 
-Id
+template<>
-getParameterAsId(const Wt::Http::ParameterMap& parameterMap, const std::string& param)
+boost::optional<Id>
+getParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param)
 {
+	boost::optional<Id> res;
+
 	auto idParam {getParameterAs<std::string>(parameterMap, "id")};
 	if (!idParam)
-		throw Error {Error::Code::RequiredParameterMissing};
+		return res;
 
-	auto id {IdFromString(*idParam)};
+	return IdFromString(*idParam);
-	if (!id)
-		throw Error {"Bad id"};
-
-	return *id;
 }
 
+template<typename T>
+T
+getMandatoryParameterAs(const Wt::Http::ParameterMap& parameterMap, const std::string& param)
+{
+	auto res {getParameterAs<T>(parameterMap, param)};
+	if (!res)
+		throw Error {Error::Code::RequiredParameterMissing};
+
+	return *res;
+}
 
 struct ClientInfo
 {
@@ -601,7 +610,7 @@ handleGetAlbumListRequestCommon(const Wt::Http::ParameterMap& request, Database:
 		releases = Database::Release::getAll(db.getSession(), offset, size);
 	}
 	else
-		throw Error {"Unsupported request"};
+		throw Error {Error::CustomType::NotImplemented};
 
 	Response response {Response::createOkResponse()};
 	Response::Node& albumListNode {response.createNode(id3 ? "albumList2" : "albumList")};
@@ -628,10 +637,10 @@ Response
 handleGetAlbumRequest(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
 	// Mandatory params
-	Id id {getParameterAsId(request, "id")};
+	Id id {getMandatoryParameterAs<Id>(request, "id")};
 
 	if (id.type != Id::Type::Release)
-		throw Error {"Unexpected id type"};
+		throw Error {Error::CustomType::BadId};
 
 	Wt::Dbo::Transaction transaction {db.getSession()};
 
@@ -655,10 +664,10 @@ Response
 handleGetArtistRequest(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
 	// Mandatory params
-	Id id {getParameterAsId(request, "id")};
+	Id id {getMandatoryParameterAs<Id>(request, "id")};
 
 	if (id.type != Id::Type::Artist)
-		throw Error {"Unexpected id type"};
+		throw Error {Error::CustomType::BadId};
 
 	Wt::Dbo::Transaction transaction {db.getSession()};
 
@@ -701,7 +710,7 @@ Response
 handleGetMusicDirectoryRequest(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
 	// Mandatory params
-	Id id {getParameterAsId(request, "id")};
+	Id id {getMandatoryParameterAs<Id>(request, "id")};
 
 	Response response {Response::createOkResponse()};
 	Response::Node& directoryNode {response.createNode("directory")};
@@ -758,7 +767,7 @@ handleGetMusicDirectoryRequest(const Wt::Http::ParameterMap& request, Database::
 		}
 
 		default:
-			throw Error {"Unexpected id type"};
+			throw Error {Error::CustomType::BadId};
 	}
 
 	return response;
@@ -820,28 +829,19 @@ handleGetIndexesRequest(const Wt::Http::ParameterMap& request, Database::Handler
 Response
 handleGetStarredRequest(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
-	Response response {Response::createOkResponse()};
+	throw Error{Error::CustomType::NotImplemented};
-	response.createNode("starred");
-
-	return response;
 }
 
 Response
 handleGetStarred2Request(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
-	Response response {Response::createOkResponse()};
+	throw Error{Error::CustomType::NotImplemented};
-	response.createNode("starred2");
-
-	return response;
 }
 
 Response
 handleGetPlaylistsRequest(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
-	Response response {Response::createOkResponse()};
+	throw Error{Error::CustomType::NotImplemented};
-	response.createNode("playlists");
-
-	return response;
 }
 
 Response
@@ -942,7 +942,7 @@ std::shared_ptr<Av::Transcoder>
 createTranscoder(const Wt::Http::ParameterMap& request, Database::Handler& db)
 {
 	// Mandatory params
-	Id id {getParameterAsId(request, "id")};
+	Id id {getMandatoryParameterAs<Id>(request, "id")};
 
 	// Optional params
 	std::size_t maxBitRate {getParameterAs<std::size_t>(request, "maxBitRate").get_value_or(128)};
@@ -987,7 +987,7 @@ handleStream(const Wt::Http::Request& request, Database::Handler& db, Wt::Http::
 	}
 
 	if (!transcoder)
-		throw Error {"transcoding failed"};
+		throw Error {Error::CustomType::InternalError};
 
 	if (!transcoder->isComplete())
 	{
@@ -1018,7 +1018,7 @@ void
 handleGetCoverArt(const Wt::Http::Request& request, Database::Handler& db, Wt::Http::Response& response)
 {
 	// Mandatory params
-	Id id {getParameterAsId(request.getParameterMap(), "id")};
+	Id id {getMandatoryParameterAs<Id>(request.getParameterMap(), "id")};
 
 	auto size {getParameterAs<std::size_t>(request.getParameterMap(), "size")};
 	if (!size)
@@ -1036,7 +1036,7 @@ handleGetCoverArt(const Wt::Http::Request& request, Database::Handler& db, Wt::H
 			cover = getServices().coverArtGrabber->getFromRelease(db.getSession(), id.id, Image::Format::JPEG, *size);
 			break;
 		default:
-			throw Error {"Unexpected id type"};
+			throw Error {Error::CustomType::BadId};
 	}
 
 	response.setMimeType( Image::format_to_mimeType(Image::Format::JPEG) );

src/api/subsonic/SubsonicResponse.cpp

@@ -66,15 +66,32 @@ ErrorCodeToString(Error::Code error)
 	}
 }
 
+static
+const char*
+CustomTypeToString(Error::CustomType type)
+{
+	switch (type)
+	{
+		case Error::CustomType::BadId:
+			return "Bad id";
+		case Error::CustomType::NotImplemented:
+			return "Not implemented";
+		case Error::CustomType::InternalError:
+			return "Internal error";
+		default:
+			return "Unknown custom error";
+	}
+}
+
 Error::Error(Code code)
 : _code {code},
 _message {ErrorCodeToString(code)}
 {
 }
 
-Error::Error(const std::string& message)
+Error::Error(Error::CustomType type)
 : _code {Code::Generic},
-_message {message}
+_message {CustomTypeToString(type)}
 {
 }
 

src/api/subsonic/SubsonicResponse.hpp

@@ -46,8 +46,15 @@ class Error
 			RequestedDataNotFound = 70,
 		};
 
+		enum class CustomType
+		{
+			BadId,
+			NotImplemented,
+			InternalError,
+		};
+
 		Error(Code code);
-		Error(const std::string& message);
+		Error(CustomType customType);
 
 		Code getCode() const { return _code; }
 		const std::string& getMessage() const { return _message; }