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
package org.mozilla.focus.home
import org.json.JSONObject
import java.util.UUID
private const val KEY_URL = "url"
private const val KEY_TITLE = "title"
private const val KEY_IMG = "img"
private const val KEY_ID = "id"
private const val KEY_ACTION = "action"
sealed class HomeTile(val url: String, val title: String) {
fun idToString() = when (this) {
is BundledHomeTile -> id
is CustomHomeTile -> id.toString()
}
protected open fun toJSONObject() = JSONObject().apply {
put(KEY_URL, url)
put(KEY_TITLE, title)
}
}
class BundledHomeTile(
url: String,
title: String,
val imagePath: String,
/** Unique id used to identify specific home tiles, e.g. for deletion, etc. **/
val id: String,
val action: TileAction
) : HomeTile(url, title) {
public override fun toJSONObject() = super.toJSONObject().apply {
put(KEY_IMG, imagePath)
put(KEY_ID, id)
}
companion object {
fun fromJSONObject(jsonObject: JSONObject): BundledHomeTile {
// Enum.valueOf will throw when passed a string that does not match
// ones of its values. This is intentional here, we want to fail
// fast upon encountering malformed JSON
val action = jsonObject.optString(KEY_ACTION, TileAction.NAVIGATE.name)
.let { actionFromJson -> TileAction.valueOf(actionFromJson) }
return BundledHomeTile(jsonObject.getString(KEY_URL),
jsonObject.getString(KEY_TITLE),
jsonObject.getString(KEY_IMG),
jsonObject.getString(KEY_ID),
action)
}
}
}
class CustomHomeTile(
url: String,
title: String,
/** Used by [HomeTileScreenshotStore] to uniquely identify tiles. */
val id: UUID
) : HomeTile(url, title) {
public override fun toJSONObject() = super.toJSONObject().apply {
put(KEY_ID, id.toString())
}
companion object {
fun fromJSONObject(jsonObject: JSONObject) = CustomHomeTile(
url = jsonObject.getString(KEY_URL),
title = jsonObject.getString(KEY_TITLE),
id = UUID.fromString(jsonObject.getString(KEY_ID))
)
}
}
/**
* Declares the type of action taken when the user interacts with the tile.
*/
enum class TileAction {
NAVIGATE, SEARCH
}