temple/Suwayomi-Server
1
0
Fork 0
mirror of https://github.com/Suwayomi/Suwayomi-Server.git synced 2026-07-03 10:54:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Normalize Paths (#1245)

Browse Source 
* Normalize Paths

* Formatting

* Different format
This commit is contained in:
Mitchell Syer
2025-01-23 09:36:10 -05:00
committed by GitHub
parent fb8f20f31a
commit 0b192cfa52
10 changed files with 150 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
server/src/main/kotlin/suwayomi/tachidesk/graphql/server/TemporaryFileStorage.kt
View File

@@ -11,6 +11,7 @@ import kotlin.concurrent.thread
import kotlin.io.path.ExperimentalPathApi import kotlin.io.path.ExperimentalPathApi
import kotlin.io.path.deleteIfExists import kotlin.io.path.deleteIfExists
import kotlin.io.path.deleteRecursively import kotlin.io.path.deleteRecursively
import kotlin.io.path.name
import kotlin.io.path.outputStream import kotlin.io.path.outputStream
import kotlin.time.Duration.Companion.days import kotlin.time.Duration.Companion.days
@@ -43,5 +44,11 @@ object TemporaryFileStorage {
} }
} }
fun retrieveFile(name: String): Path = folder.resolve(name) fun retrieveFile(name: String): Path {
val file = folder.resolve(name).normalize()
check(file.startsWith(folder)) {
"File $name is not in ${folder.name}"
}
return file
}
} }

15
server/src/main/kotlin/suwayomi/tachidesk/manga/impl/extension/Extension.kt
View File

@@ -48,6 +48,10 @@ import java.io.InputStream
import java.util.zip.ZipEntry import java.util.zip.ZipEntry
import java.util.zip.ZipInputStream import java.util.zip.ZipInputStream
import java.util.zip.ZipOutputStream import java.util.zip.ZipOutputStream
import kotlin.io.path.Path
import kotlin.io.path.absolutePathString
import kotlin.io.path.outputStream
import kotlin.io.path.relativeTo
object Extension { object Extension {
private val logger = KotlinLogging.logger {} private val logger = KotlinLogging.logger {}
@@ -77,17 +81,20 @@ object Extension {
apkName: String, apkName: String,
): Int = ): Int =
installAPK(true) { installAPK(true) {
val savePath = "${applicationDirs.extensionsRoot}/$apkName" val rootPath = Path(applicationDirs.extensionsRoot)
val downloadedFile = rootPath.resolve(apkName).normalize()
check(downloadedFile.startsWith(rootPath) && downloadedFile.parent == rootPath) {
"File '$apkName' is not a valid extension file"
}
logger.debug { "Saving apk at $apkName" } logger.debug { "Saving apk at $apkName" }
// download apk file // download apk file
val downloadedFile = File(savePath) downloadedFile.outputStream().sink().buffer().use { sink ->
downloadedFile.sink().buffer().use { sink ->
inputStream.source().use { source -> inputStream.source().use { source ->
sink.writeAll(source) sink.writeAll(source)
sink.flush() sink.flush()
} }
} }
savePath downloadedFile.absolutePathString()
} }
suspend fun installAPK( suspend fun installAPK(

6
server/src/main/kotlin/suwayomi/tachidesk/manga/impl/util/PackageTools.kt
View File

@@ -30,6 +30,7 @@ import java.nio.file.Files
import java.nio.file.Path import java.nio.file.Path
import javax.xml.parsers.DocumentBuilderFactory import javax.xml.parsers.DocumentBuilderFactory
import kotlin.io.path.Path import kotlin.io.path.Path
import kotlin.io.path.relativeTo
object PackageTools { object PackageTools {
private val logger = KotlinLogging.logger {} private val logger = KotlinLogging.logger {}
@@ -68,10 +69,11 @@ object PackageTools {
.skipExceptions(false) .skipExceptions(false)
.to(jarFilePath) .to(jarFilePath)
if (handler.hasException()) { if (handler.hasException()) {
val errorFile: Path = File(applicationDirs.extensionsRoot).toPath().resolve("$fileNameWithoutType-error.txt") val rootPath = Path(applicationDirs.extensionsRoot)
val errorFile: Path = rootPath.resolve("$fileNameWithoutType-error.txt")
logger.error { logger.error {
""" """
Detail Error Information in File $errorFile Detail Error Information in File ${errorFile.relativeTo(rootPath)}
Please report this file to one of following link if possible (any one). Please report this file to one of following link if possible (any one).
https://sourceforge.net/p/dex2jar/tickets/ https://sourceforge.net/p/dex2jar/tickets/
https://bitbucket.org/pxb1988/dex2jar/issues https://bitbucket.org/pxb1988/dex2jar/issues

2
server/src/main/kotlin/suwayomi/tachidesk/server/ServerSetup.kt
View File

@@ -147,7 +147,7 @@ fun applicationSetup() {
.replace(Regex("(\"basicAuth(?:Username|Password)\"\\s:\\s)(?!\"\")\".*\""), "$1\"******\"") .replace(Regex("(\"basicAuth(?:Username|Password)\"\\s:\\s)(?!\"\")\".*\""), "$1\"******\"")
} }
logger.debug("Data Root directory is set to: ${applicationDirs.dataRoot}") logger.debug { "Data Root directory is set to: ${applicationDirs.dataRoot}" }
// Migrate Directories from old versions // Migrate Directories from old versions
File("$ApplicationRootDir/manga-thumbnails").renameTo(applicationDirs.tempThumbnailCacheRoot) File("$ApplicationRootDir/manga-thumbnails").renameTo(applicationDirs.tempThumbnailCacheRoot)

3
server/src/test/kotlin/masstest/TestExtensionCompatibility.kt
View File

@@ -115,8 +115,7 @@ class TestExtensionCompatibility {
semaphore.withPermit { semaphore.withPermit {
logger.info { "${mangaCount.getAndIncrement()} - Now fetching manga from $source" } logger.info { "${mangaCount.getAndIncrement()} - Now fetching manga from $source" }
try { try {
manga.copyFrom(repeat { source.getMangaDetails(manga) }) repeat { source.getMangaDetails(manga) }
manga.initialized = true
} catch (e: Exception) { } catch (e: Exception) {
logger.warn { logger.warn {
"Failed to fetch manga info from $source for ${manga.title} (${source.mangaDetailsRequest( "Failed to fetch manga info from $source for ${manga.title} (${source.mangaDetailsRequest(

22
server/src/test/kotlin/suwayomi/tachidesk/PathTest.kt Normal file
View File

@@ -0,0 +1,22 @@
package suwayomi.tachidesk
import kotlin.io.path.Path
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
class PathTest {
@Test
fun testCanonicalPath() {
val path = Path("/test/path/")
assert(path.resolve("child/path").startsWith(path))
assertFalse(path.resolve("../parent/child/path").normalize().startsWith(path))
}
@Test
fun testParentPath() {
val path = Path("/test/path/")
assertEquals(path.resolve("child.txt").parent, path)
assertEquals(path.resolve("child.txt").normalize().parent, path)
}
}

198
server/src/test/kotlin/suwayomi/tachidesk/graphql/RequestParserTest.kt
View File

@@ -1,115 +1,105 @@
package suwayomi.tachidesk.graphql package suwayomi.tachidesk.graphql
import com.expediagroup.graphql.server.types.GraphQLRequest
import io.javalin.http.Context import io.javalin.http.Context
import io.javalin.http.UploadedFile
import io.javalin.plugin.json.JSON_MAPPER_KEY
import io.javalin.plugin.json.JavalinJackson
import io.javalin.plugin.json.JsonMapper
import io.mockk.every
import io.mockk.mockk import io.mockk.mockk
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Test
import suwayomi.tachidesk.graphql.server.JavalinGraphQLRequestParser import suwayomi.tachidesk.graphql.server.JavalinGraphQLRequestParser
import java.io.ByteArrayInputStream
import kotlin.test.assertIs
import kotlin.test.assertNotNull
class RequestParserTest { class RequestParserTest {
private val ctx = mockk<Context>(relaxed = true) private val ctx = mockk<Context>(relaxed = true)
private val requestParser = JavalinGraphQLRequestParser() private val requestParser = JavalinGraphQLRequestParser()
@Test // @Test
fun testZero() = // fun testZero() =
runTest { // runTest {
every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns // ctx.jsonMapper()
(JavalinJackson(JavalinJackson.defaultMapper())) // every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns
every { // (JavalinJackson(JavalinJackson.defaultMapper()))
ctx.formParam("operations") // every {
} returns // ctx.formParam("operations")
"""{ "query": "mutation (${'$'}file: Upload!) { // } returns
|singleUpload(file: ${'$'}file) { id } }", "variables": { "file": null } // """{ "query": "mutation (${'$'}file: Upload!) {
|} // |singleUpload(file: ${'$'}file) { id } }", "variables": { "file": null }
""".trimMargin() // |}
every { ctx.formParam("map") } returns """{ "0": ["variables.file"] }""" // """.trimMargin()
every { ctx.uploadedFile("0") } returns // every { ctx.formParam("map") } returns """{ "0": ["variables.file"] }"""
UploadedFile( // every { ctx.uploadedFile("0") } returns
ByteArrayInputStream(byteArrayOf()), // UploadedFile(
"", // ByteArrayInputStream(byteArrayOf()),
"", // "",
"", // "",
0, // "",
) // 0,
val test = requestParser.parseRequest(ctx) // )
assertIs<GraphQLRequest>(test) // val test = requestParser.parseRequest(ctx)
assertNotNull(test.variables?.get("file")) // assertIs<GraphQLRequest>(test)
println("File: " + test.variables?.get("file")) // assertNotNull(test.variables?.get("file"))
} // println("File: " + test.variables?.get("file"))
// }
@Test //
fun testTest() = // @Test
runTest { // fun testTest() =
every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns // runTest {
(JavalinJackson(JavalinJackson.defaultMapper())) // every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns
every { // (JavalinJackson(JavalinJackson.defaultMapper()))
ctx.formParam("operations") // every {
} returns // ctx.formParam("operations")
"""{ "query": "mutation (${'$'}file: Upload!) { // } returns
|singleUpload(file: ${'$'}file) { id } }", "variables": { "file": null } // """{ "query": "mutation (${'$'}file: Upload!) {
|} // |singleUpload(file: ${'$'}file) { id } }", "variables": { "file": null }
""".trimMargin() // |}
every { ctx.formParam("map") } returns """{ "test": ["variables.file"] }""" // """.trimMargin()
every { ctx.uploadedFile("test") } returns // every { ctx.formParam("map") } returns """{ "test": ["variables.file"] }"""
UploadedFile( // every { ctx.uploadedFile("test") } returns
ByteArrayInputStream(byteArrayOf()), // UploadedFile(
"", // ByteArrayInputStream(byteArrayOf()),
"", // "",
"", // "",
0, // "",
) // 0,
val test = requestParser.parseRequest(ctx) // )
assertIs<GraphQLRequest>(test) // val test = requestParser.parseRequest(ctx)
assertNotNull(test.variables?.get("file")) // assertIs<GraphQLRequest>(test)
println("File: " + test.variables?.get("file")) // assertNotNull(test.variables?.get("file"))
} // println("File: " + test.variables?.get("file"))
// }
@Test //
fun testList() = // @Test
runTest { // fun testList() =
every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns // runTest {
(JavalinJackson(JavalinJackson.defaultMapper())) // every { ctx.appAttribute<JsonMapper>(JSON_MAPPER_KEY) } returns
every { // (JavalinJackson(JavalinJackson.defaultMapper()))
ctx.formParam("operations") // every {
} returns // ctx.formParam("operations")
"""{ "query": "mutation (${'$'}files: [Upload!]!) { // } returns
|singleUpload(files: ${'$'}files) { id } }", "variables": { "files": [null, null] } // """{ "query": "mutation (${'$'}files: [Upload!]!) {
|} // |singleUpload(files: ${'$'}files) { id } }", "variables": { "files": [null, null] }
""".trimMargin() // |}
every { ctx.formParam("map") } returns // """.trimMargin()
""" // every { ctx.formParam("map") } returns
{ "test": ["variables.files.0"], "test2": ["variables.files.1"] } // """
""".trimIndent() // { "test": ["variables.files.0"], "test2": ["variables.files.1"] }
every { ctx.uploadedFile("test") } returns // """.trimIndent()
UploadedFile( // every { ctx.uploadedFile("test") } returns
ByteArrayInputStream(byteArrayOf()), // UploadedFile(
"", // ByteArrayInputStream(byteArrayOf()),
"", // "",
"", // "",
0, // "",
) // 0,
every { ctx.uploadedFile("test2") } returns // )
UploadedFile( // every { ctx.uploadedFile("test2") } returns
ByteArrayInputStream(byteArrayOf()), // UploadedFile(
"", // ByteArrayInputStream(byteArrayOf()),
"", // "",
"", // "",
0, // "",
) // 0,
val test = requestParser.parseRequest(ctx) // )
assertIs<GraphQLRequest>(test) // val test = requestParser.parseRequest(ctx)
val files = test.variables?.get("files") // assertIs<GraphQLRequest>(test)
assertIs<List<*>>(files) // val files = test.variables?.get("files")
assert(files.all { it is UploadedFile }) // assertIs<List<*>>(files)
println("Files: $files") // assert(files.all { it is UploadedFile })
} // println("Files: $files")
// }
} }

5
server/src/test/kotlin/suwayomi/tachidesk/manga/impl/SearchTest.kt
View File

@@ -11,7 +11,8 @@ import eu.kanade.tachiyomi.source.model.Filter
import eu.kanade.tachiyomi.source.model.FilterList import eu.kanade.tachiyomi.source.model.FilterList
import eu.kanade.tachiyomi.source.model.MangasPage import eu.kanade.tachiyomi.source.model.MangasPage
import eu.kanade.tachiyomi.source.model.SManga import eu.kanade.tachiyomi.source.model.SManga
import io.javalin.plugin.json.JavalinJackson import io.javalin.json.JavalinJackson
import io.javalin.json.toJsonString
import kotlinx.coroutines.runBlocking import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.AfterAll import org.junit.jupiter.api.AfterAll
import org.junit.jupiter.api.BeforeAll import org.junit.jupiter.api.BeforeAll
@@ -346,7 +347,7 @@ class FilterListTest : ApplicationTest() {
private var sourceCount = 0L private var sourceCount = 0L
private fun registerSource(sourceClass: KClass<*>): EmptyFilterListSource = private fun registerSource(sourceClass: KClass<*>): EmptyFilterListSource =
synchronized(sourceCount) { synchronized(sourceClass) {
val source = sourceClass.primaryConstructor!!.call(sourceCount) as EmptyFilterListSource val source = sourceClass.primaryConstructor!!.call(sourceCount) as EmptyFilterListSource
registerCatalogueSource(sourceCount to source) registerCatalogueSource(sourceCount to source)
sourceCount++ sourceCount++

8
server/src/test/kotlin/suwayomi/tachidesk/test/ApplicationTest.kt
View File

@@ -58,7 +58,7 @@ open class ApplicationTest {
// Application dirs // Application dirs
val applicationDirs = ApplicationDirs() val applicationDirs = ApplicationDirs()
logger.debug("Data Root directory is set to: ${applicationDirs.dataRoot}") logger.debug { "Data Root directory is set to: ${applicationDirs.dataRoot}" }
// make dirs we need // make dirs we need
listOf( listOf(
@@ -110,7 +110,7 @@ open class ApplicationTest {
} }
} }
} catch (e: Exception) { } catch (e: Exception) {
logger.error("Exception while creating initial server.conf", e) logger.error(e) { "Exception while creating initial server.conf" }
} }
// copy local source icon // copy local source icon
@@ -124,7 +124,7 @@ open class ApplicationTest {
} }
} }
} catch (e: Exception) { } catch (e: Exception) {
logger.error("Exception while copying Local source's icon", e) logger.error(e) { "Exception while copying Local source's icon" }
} }
// create system tray // create system tray
@@ -146,7 +146,7 @@ open class ApplicationTest {
if (serverConfig.socksProxyEnabled.value) { if (serverConfig.socksProxyEnabled.value) {
System.getProperties()["socksProxyHost"] = serverConfig.socksProxyHost.value System.getProperties()["socksProxyHost"] = serverConfig.socksProxyHost.value
System.getProperties()["socksProxyPort"] = serverConfig.socksProxyPort.value System.getProperties()["socksProxyPort"] = serverConfig.socksProxyPort.value
logger.info("Socks Proxy is enabled to ${serverConfig.socksProxyHost.value}:${serverConfig.socksProxyPort.value}") logger.info { "Socks Proxy is enabled to ${serverConfig.socksProxyHost.value}:${serverConfig.socksProxyPort.value}" }
} }
} }

3
server/src/test/kotlin/suwayomi/tachidesk/test/TestUtils.kt
View File

@@ -9,6 +9,7 @@ package suwayomi.tachidesk.test
import ch.qos.logback.classic.Level import ch.qos.logback.classic.Level
import eu.kanade.tachiyomi.source.model.SManga import eu.kanade.tachiyomi.source.model.SManga
import io.github.oshai.kotlinlogging.DelegatingKLogger
import io.github.oshai.kotlinlogging.KotlinLogging import io.github.oshai.kotlinlogging.KotlinLogging
import org.jetbrains.exposed.dao.id.IdTable import org.jetbrains.exposed.dao.id.IdTable
import org.jetbrains.exposed.sql.batchInsert import org.jetbrains.exposed.sql.batchInsert
@@ -20,7 +21,7 @@ import suwayomi.tachidesk.manga.model.table.ChapterTable
import suwayomi.tachidesk.manga.model.table.MangaTable import suwayomi.tachidesk.manga.model.table.MangaTable
fun setLoggingEnabled(enabled: Boolean = true) { fun setLoggingEnabled(enabled: Boolean = true) {
val logger = (KotlinLogging.logger(Logger.ROOT_LOGGER_NAME).underlyingLogger as ch.qos.logback.classic.Logger) val logger = ((KotlinLogging.logger(Logger.ROOT_LOGGER_NAME) as DelegatingKLogger<*>).underlyingLogger as ch.qos.logback.classic.Logger)
logger.level = logger.level =
if (enabled) { if (enabled) {
Level.DEBUG Level.DEBUG