Skip to content

fix: add specific error message for plain permalink sites #25703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmustafasenoglu wants to merge 1 commit into
base: trunk
Choose a base branch
from
+12 −0
Open

fix: add specific error message for plain permalink sites #25703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions WordPress/Classes/Login/SelfHostedSiteAuthenticator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ struct SelfHostedSiteAuthenticator {
case xmlrpcDisabled(Error)
case xmlrpcEndpointNotFound
case loadingSiteInfoFailure(Error)
case plainPermalinkNotSupported(apiRootURL: String)
case savingSiteFailure
case mismatchedUser(expectedUsername: String)
case cancelled
Expand All @@ -90,6 +91,12 @@ struct SelfHostedSiteAuthenticator {
value: "Cannot load the WordPress site details",
comment: "Error message shown when failing to load details from a self-hosted WordPress site"
)
case .plainPermalinkNotSupported:
return NSLocalizedString(
"addSite.selfHosted.plainPermalinkNotSupported",
value: "This site uses plain permalinks, which are not fully supported. Please enable pretty permalinks in Settings > Permalinks, or contact your hosting provider for assistance.",
comment: "Error message when a self-hosted site uses plain permalinks (rest_route query form) which causes REST API issues"
)
case .savingSiteFailure:
return NSLocalizedString(
"addSite.selfHosted.savingSiteFailure",
Expand Down Expand Up @@ -386,6 +393,11 @@ struct SelfHostedSiteAuthenticator {
(siteSettings, isAdmin, jetpackSite, jetpackConnection, xmlrpcOptions) =
try await (siteSettings_, isAdmin_, jetpackSite_, jetpackConnection_, xmlrpcOptions_)
} catch {
// If the API root URL uses the rest_route query-parameter form
// (plain permalinks), provide a more actionable error message.
if apiRootURL.query(forKey: "rest_route") != nil {
throw .plainPermalinkNotSupported(apiRootURL: apiRootURL.absoluteString)
}
throw .loadingSiteInfoFailure(error)
}

Expand Down