-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add a "export" extension to colibri2.
- Loading branch information
Showing
8 changed files
with
244 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
src/main/kotlin/org/jitsi/xmpp/extensions/colibri2/Export.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
/* | ||
* Copyright @ 2024 - present 8x8, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jitsi.xmpp.extensions.colibri2 | ||
|
||
import org.jitsi.xmpp.extensions.AbstractPacketExtension | ||
import org.jitsi.xmpp.extensions.DefaultPacketExtensionProvider | ||
import org.jivesoftware.smack.packet.XmlEnvironment | ||
import org.jivesoftware.smack.parsing.SmackParsingException | ||
import org.jivesoftware.smack.xml.XmlPullParser | ||
import org.jivesoftware.smack.xml.XmlPullParserException | ||
import java.io.IOException | ||
import java.net.URI | ||
import java.net.URISyntaxException | ||
|
||
class Export( | ||
val url: URI, | ||
audio: Boolean = false, | ||
video: Boolean = false | ||
) : AbstractPacketExtension(NAMESPACE, ELEMENT) { | ||
init { | ||
setAttribute(URL_ATTR_NAME, url) | ||
if (audio) { | ||
setAttribute(AUDIO_ATTR_NAME, true) | ||
} | ||
if (video) { | ||
setAttribute(VIDEO_ATTR_NAME, true) | ||
} | ||
} | ||
|
||
val audio: Boolean | ||
get() = getAttributeAsString(AUDIO_ATTR_NAME)?.toBoolean() ?: false | ||
val video: Boolean | ||
get() = getAttributeAsString(VIDEO_ATTR_NAME)?.toBoolean() ?: false | ||
|
||
companion object { | ||
const val ELEMENT = "export" | ||
const val NAMESPACE = ConferenceModifyIQ.NAMESPACE | ||
const val URL_ATTR_NAME = "url" | ||
const val AUDIO_ATTR_NAME = "audio" | ||
const val VIDEO_ATTR_NAME = "video" | ||
} | ||
} | ||
|
||
class ExportProvider : DefaultPacketExtensionProvider<Export>(Export::class.java) { | ||
@Throws(XmlPullParserException::class, IOException::class, SmackParsingException::class) | ||
override fun parse(parser: XmlPullParser, depth: Int, xml: XmlEnvironment?): Export { | ||
val url = parser.getAttributeValue("", Export.URL_ATTR_NAME) | ||
?: throw SmackParsingException.RequiredAttributeMissingException("Missing 'url' attribute") | ||
val audio = parser.getAttributeValue("", Export.AUDIO_ATTR_NAME)?.toBoolean() ?: false | ||
val video = parser.getAttributeValue("", Export.VIDEO_ATTR_NAME)?.toBoolean() ?: false | ||
|
||
try { | ||
return Export(URI(url), audio, video) | ||
} catch (e: URISyntaxException) { | ||
throw SmackParsingException("Invalid 'url': ${e.message}") | ||
} | ||
} | ||
} |
32 changes: 32 additions & 0 deletions
32
src/main/kotlin/org/jitsi/xmpp/extensions/colibri2/Exports.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* | ||
* Copyright @ 2024 - present 8x8, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jitsi.xmpp.extensions.colibri2 | ||
|
||
import org.jitsi.xmpp.extensions.AbstractPacketExtension | ||
import org.jitsi.xmpp.extensions.DefaultPacketExtensionProvider | ||
|
||
class Exports : AbstractPacketExtension(NAMESPACE, ELEMENT) { | ||
|
||
fun getExports(): List<Export> = getChildExtensionsOfType(Export::class.java) | ||
fun addExport(export: Export) = addChildExtension(export) | ||
|
||
companion object { | ||
const val ELEMENT = "exports" | ||
const val NAMESPACE = ConferenceModifyIQ.NAMESPACE | ||
} | ||
} | ||
|
||
class ExportsProvider : DefaultPacketExtensionProvider<Exports>(Exports::class.java) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
src/test/kotlin/org/jitsi/xmpp/extensions/colibri2/ExportTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
/* | ||
* Copyright @ 2024 - present 8x8, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jitsi.xmpp.extensions.colibri2 | ||
|
||
import io.kotest.assertions.throwables.shouldThrow | ||
import io.kotest.core.spec.style.ShouldSpec | ||
import io.kotest.matchers.shouldBe | ||
import org.jivesoftware.smack.parsing.SmackParsingException | ||
import org.jivesoftware.smack.util.PacketParserUtils | ||
import java.net.URI | ||
|
||
class ExportTest : ShouldSpec() { | ||
init { | ||
IqProviderUtils.registerProviders() | ||
val provider = ExportProvider() | ||
val url = "ws://example.com" | ||
|
||
context("Parsing a valid extension") { | ||
context("Without audio/video") { | ||
val export = provider.parse(PacketParserUtils.getParserFor("<export url='$url'/>")) | ||
export.url shouldBe URI(url) | ||
export.audio shouldBe false | ||
export.video shouldBe false | ||
} | ||
context("With audio") { | ||
val export = provider.parse(PacketParserUtils.getParserFor("<export url='$url' audio='true'/>")) | ||
export.url shouldBe URI(url) | ||
export.audio shouldBe true | ||
export.video shouldBe false | ||
} | ||
context("With video") { | ||
val export = provider.parse( | ||
PacketParserUtils.getParserFor("<export url='$url' audio='false' video='true'/>") | ||
) | ||
export.url shouldBe URI(url) | ||
export.audio shouldBe false | ||
export.video shouldBe true | ||
} | ||
} | ||
context("Parsing with missing url") { | ||
shouldThrow<SmackParsingException> { | ||
provider.parse(PacketParserUtils.getParserFor("<export/>")) | ||
} | ||
} | ||
context("Parsing with invalid url") { | ||
shouldThrow<SmackParsingException> { | ||
provider.parse(PacketParserUtils.getParserFor("<export url='in val id'/>")) | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters