2023-11-11 13:41:20 +00:00
|
|
|
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: source/migrations.bs</title><!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
2023-11-16 17:58:48 +00:00
|
|
|
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://jellyfin.github.io/jellyfin-roku/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d=
|
|
|
|
|
import "pkg:/source/utils/conditional.bs"
|
2023-10-27 12:27:26 +00:00
|
|
|
|
2023-11-16 17:58:48 +00:00
|
|
|
' @fileoverview Functions that update the registry based on the last run version and the currently running version
|
|
|
|
|
|
|
|
|
|
const CLIENT_VERSION_REQUIRING_BASE_MIGRATION = "2.0.0"
|
2023-10-27 12:27:26 +00:00
|
|
|
|
|
|
|
|
' Run all necessary registry mirations on the "global" Jellyfin registry section
|
|
|
|
|
sub runGlobalMigrations()
|
2023-11-16 17:58:48 +00:00
|
|
|
appLastRunVersion = m.global.app.lastRunVersion
|
2023-10-27 12:27:26 +00:00
|
|
|
' Global registry migrations
|
2023-11-16 17:58:48 +00:00
|
|
|
if isValid(appLastRunVersion) and not versionChecker(appLastRunVersion, CLIENT_VERSION_REQUIRING_BASE_MIGRATION)
|
2023-11-18 13:34:30 +00:00
|
|
|
' last app version used < CLIENT_VERSION_REQUIRING_BASE_MIGRATION
|
2023-11-16 17:58:48 +00:00
|
|
|
m.wasMigrated = true
|
|
|
|
|
print `Running ${CLIENT_VERSION_REQUIRING_BASE_MIGRATION} global registry migrations`
|
2023-10-27 12:27:26 +00:00
|
|
|
' no longer saving raw password to registry
|
|
|
|
|
' auth token and username are now stored in user settings and not global settings
|
|
|
|
|
|
2023-11-24 22:27:28 +00:00
|
|
|
' enable remember me global setting for all devices whos last run version is < 2.0.0
|
|
|
|
|
' NOTE: remember me will be disabled for new installs
|
|
|
|
|
rememberMe = registry_read("global.rememberme", "Jellyfin")
|
|
|
|
|
if not isValid(rememberMe)
|
|
|
|
|
' don't overwrite users current setting (dev installs)
|
|
|
|
|
set_setting("global.rememberme", "true")
|
|
|
|
|
end if
|
2023-11-18 13:34:30 +00:00
|
|
|
' migrate saved credentials for "active_user" if found
|
2023-10-27 12:27:26 +00:00
|
|
|
savedUserId = get_setting("active_user")
|
|
|
|
|
if isValid(savedUserId)
|
|
|
|
|
savedUsername = get_setting("username")
|
|
|
|
|
if isValid(savedUsername)
|
|
|
|
|
registry_write("username", savedUsername, savedUserId)
|
|
|
|
|
end if
|
|
|
|
|
|
|
|
|
|
savedToken = get_setting("token")
|
|
|
|
|
if isValid(savedToken)
|
|
|
|
|
registry_write("token", savedToken, savedUserId)
|
|
|
|
|
end if
|
|
|
|
|
end if
|
2023-11-18 13:34:30 +00:00
|
|
|
' remove settings from global "jellyfin" registry block
|
2023-10-27 12:27:26 +00:00
|
|
|
unset_setting("port")
|
|
|
|
|
unset_setting("token")
|
|
|
|
|
unset_setting("username")
|
|
|
|
|
unset_setting("password")
|
2023-11-18 13:34:30 +00:00
|
|
|
' remove any saved credentials found in saved_servers assocArray
|
2023-10-27 12:27:26 +00:00
|
|
|
saved = get_setting("saved_servers")
|
|
|
|
|
if isValid(saved)
|
|
|
|
|
savedServers = ParseJson(saved)
|
|
|
|
|
if isValid(savedServers.serverList) and savedServers.serverList.Count() > 0
|
|
|
|
|
newServers = { serverList: [] }
|
|
|
|
|
for each item in savedServers.serverList
|
|
|
|
|
item.Delete("username")
|
|
|
|
|
item.Delete("password")
|
|
|
|
|
newServers.serverList.Push(item)
|
|
|
|
|
end for
|
|
|
|
|
set_setting("saved_servers", FormatJson(newServers))
|
|
|
|
|
end if
|
|
|
|
|
end if
|
|
|
|
|
end if
|
|
|
|
|
end sub
|
|
|
|
|
|
2023-11-16 17:58:48 +00:00
|
|
|
sub runRegistryUserMigrations()
|
2023-10-27 12:27:26 +00:00
|
|
|
regSections = getRegistrySections()
|
|
|
|
|
for each section in regSections
|
|
|
|
|
if LCase(section) <> "jellyfin"
|
2023-11-16 17:58:48 +00:00
|
|
|
reg = CreateObject("roRegistrySection", section)
|
|
|
|
|
if reg.exists("LastRunVersion")
|
|
|
|
|
hasUserVersion = true
|
|
|
|
|
lastRunVersion = reg.read("LastRunVersion")
|
|
|
|
|
else
|
|
|
|
|
hasUserVersion = false
|
|
|
|
|
' app versions < 2.0.0 didn't save LastRunVersion at the user level
|
|
|
|
|
' fall back to using the apps lastRunVersion
|
|
|
|
|
lastRunVersion = m.global.app.lastRunVersion
|
2023-10-27 12:27:26 +00:00
|
|
|
registry_write("LastRunVersion", m.global.app.version, section)
|
2023-11-16 17:58:48 +00:00
|
|
|
end if
|
|
|
|
|
|
|
|
|
|
' BASE_MIGRATION
|
|
|
|
|
if not versionChecker(lastRunVersion, CLIENT_VERSION_REQUIRING_BASE_MIGRATION)
|
|
|
|
|
m.wasMigrated = true
|
|
|
|
|
print `Running Registry Migration for ${CLIENT_VERSION_REQUIRING_BASE_MIGRATION} for userid: ${section}`
|
|
|
|
|
|
2023-10-27 12:27:26 +00:00
|
|
|
' no longer saving password to registry
|
|
|
|
|
registry_delete("password", section)
|
|
|
|
|
' av1 playback no longer hidden behind user setting
|
|
|
|
|
registry_delete("playback.av1", section)
|
|
|
|
|
end if
|
2023-11-16 17:58:48 +00:00
|
|
|
|
|
|
|
|
' update lastRunVersion if needed
|
|
|
|
|
if hasUserVersion and lastRunVersion <> m.global.app.version
|
|
|
|
|
registry_write("LastRunVersion", m.global.app.version, section)
|
|
|
|
|
end if
|
2023-10-27 12:27:26 +00:00
|
|
|
end if
|
|
|
|
|
end for
|
|
|
|
|
end sub
|
2023-11-16 17:58:48 +00:00
|
|
|
</code></pre></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper"><span class="jsdoc-message">Automatically generated using <a href="https://github.com/jsdoc/jsdoc" target="_blank">JSDoc</a> and the <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme" target="_blank">clean-jsdoc-theme</a>.</span></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">jellyfin-roku Code Documentation</a><div class="mobile-nav-links"><div class="external-link navbar-item"><a id="jellyfin-link-mobile" href="https://jellyfin.org/" target="_blank">Jellyfin</a></div><div class="external-link navbar-item"><a id="github-link-mobile" href="https://github.com/jellyfin/jellyfin-roku" target="_blank">GitHub</a></div><div class="external-link navbar-item"><a id="forum-link-mobile" href="https://forum.jellyfin.org/f-roku-development" target="_blank">Forum</a></div><div class="external-link navbar-item"><a id="matrix-link-mobile" href="https://matrix.to/#/#jellyfin-dev-roku:matrix.org" target="_blank">Matrix</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-AlbumData.html">AlbumData</a></div><div class="sidebar-section-children"><a href="module-AlbumGrid.html">AlbumGrid</a></div><div class="sidebar-section-children"><a href="module-AlbumTrackList.html">AlbumTrackList</a></div><div class="sidebar-section-children"><a href="module-AlbumView.html">AlbumView</a></div><div class="sidebar-section-children"><a href="module-Alpha.html">Alpha</a></div><div class="sidebar-section-children"><a href="module-ArtistView.html">ArtistView</a></div><div class="sidebar-section-children"><a href="module-AudioPlayer.html">AudioPlayer</a></div><div class="sidebar-section-children"><a href="module-AudioPlayerView.html">AudioPlayerView</a></div><div class="sidebar-section-children"><a href="module-AudioTrackListItem.html">AudioTrackListItem</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupHoriz.html">ButtonGroupHoriz</a></div><div class="sidebar-section-children"><a href="module-ButtonGroupVert.html">ButtonGroupVert</a></div><div class="sidebar-section-children"><a href="module-ChannelData.html">ChannelData</a></div><div class="sidebar-section-children"><a href="module-Clock.html">Clock</a></div><div class="sidebar-section-children"><a href="module-CollectionData.html">CollectionData</a></div><div class="sidebar-section-children"><a href="module-ConfigData.html">ConfigData</a></div><div class="sidebar-section-children"><a href="module-ConfigItem.html">ConfigItem</a></div><div class="sidebar-section-children"><a href="module-ConfigList.html">ConfigList</a></div><div class="sidebar-section-children"><a href="module-ExtrasItem.html">ExtrasItem</a></div><div class="sidebar-section-children"><a href="module-ExtrasRowList.html">ExtrasRowList</a></div><div class="sidebar-section-children"><a href="module-FavoriteItemsTask.html">FavoriteItemsTask</a></div><div class="sidebar-section-children"><a href="module-Folder
|
