mozilla-mobile/firefox-ios/BrowserKit/Sources/Shared/SupportUtils.swift

Revision control

Copy as Markdown

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/
import Common
import Foundation
import UIKit
/// Utility functions related to SUMO and Webcompat
public struct SupportUtils {
public static var URLForPrivateBrowsingLearnMore: URL? {
// Returns the predefined URL associated to private homepage message card learn more action.
}
public static var URLForWhatsNew: URL? {
// Returns the predefined URL associated to what's new button action.
}
public static var URLForGetHelp: URL? {
// Returns the predefined URL associated to the menu's Get Help button action.
}
public static var URLForPocketLearnMore: URL? {
// Returns the predefined URL associated to homepage Pocket's Learn more action.
}
public static func URLForTopic(_ topic: String) -> URL? {
// Construct a NSURL pointing to a specific topic on SUMO. The topic should be a non-escaped string. It will
// be properly escaped by this function.
//
// The resulting NSURL will include the app version, operating system and locale code. For example, a topic
// "cheese" will be turned into a link that looks like https://support.mozilla.org/1/mobile/2.0/iOS/en-US/cheese
guard let escapedTopic = topic.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed),
let languageIdentifier = Locale.preferredLanguages.first
else {
return nil
}
}
public static func URLForPrivacyNotice(source: String, campaign: String, content: String?) -> URL? {
let defaultURL = URL(string: "https://www.mozilla.org/privacy/firefox")
guard let languageIdentifier = Locale.preferredLanguages.first else {
return defaultURL
}
var privacyNoticeString =
if let content {
privacyNoticeString.append("&utm_content=\(content)")
}
return URL(string: privacyNoticeString) ?? defaultURL
}
public static func URLForReportSiteIssue(_ siteUrl: String?) -> URL? {
// Construct a NSURL pointing to the webcompat.com server to report an issue.
//
// It specifies the source as mobile-reporter. This helps the webcompat server to classify the issue.
// It also adds browser-firefox-ios to the labels in the URL to make it clear
// that this about Firefox on iOS. It makes it easier for webcompat people doing triage and diagnostics.
// It adds a device-type label to help discriminating in between tablet and mobile devices.
let deviceType: String
if UIDevice.current.userInterfaceIdiom == .pad {
deviceType = "device-tablet"
} else {
deviceType = "device-mobile"
}
guard let escapedUrl = siteUrl?.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed)
else {
return nil
}
}
}