Added functionality to export a single playlist #5779

Zeabyte · 2024-10-01T16:35:24Z

Single Playlist Export

Pull Request Type

Bugfix
Feature Implementation
Documentation
Other

Related issue

Description

This PR adds a button "Export Playlist" to the playlist-info component, that when clicked exports a single playlist with the file name "freetube-playlist-{playlistName}-{date}.db".

Screenshots

After:

Testing

I have tested this and found no problems. However, the UX is not perfect because this is only exporting. Importing currently requires going to data settings and there is no "Do you wish to overwrite the playlist" or "... add the videos to the local playlist" with the same name.

Desktop

OS: Fedora Workstation
OS Version: 40
FreeTube version: latest from development

Additional context

One could further abstract the way files are saved to disk. I have copied it from data-settings.js.
I have reused the locale token Settings.Data Settings.Unable to write file.

src/renderer/components/playlist-info/playlist-info.js

Co-authored-by: PikachuEXE <git@pikachuexe.net>

…port file name

PikachuEXE · 2024-10-07T07:12:28Z

src/renderer/components/playlist-info/playlist-info.js

@@ -412,6 +415,41 @@ export default defineComponent({
      showToast(this.playlistDeletionDisabledLabel)
    },

+    handlePlaylistExport: async function () {
+      const dateStr = getTodayDateStrLocalTimezone()
+      const title = this.selectedUserPlaylist.playlistName.replaceAll(' ', '_').replaceAll(/["%*/:<>?\\|]/g, '_')


Might need to replace more chars
See
https://www.mtu.edu/umc/services/websites/writing/characters-avoid/

I use Special !@#$%^&*()-_=+[]{};:'".>/?\| List as test name and I got freetube-playlist-Special_!@#$_^&_()-_=+[]{};_'_.______List-2024-10-07 on MacOS
Need a windows guy to test the result

@PikachuEXE I thought that the characters I listed in the Regexp would be those that are absolutely illegal for use in certain OS’s. The guide you linked calls some absolutely common, usual and legal characters "illegal" and "forbidden". So, just to confirm, this is more about conventions, right?

Thanks for having a look at it.

I didn't have access to Windows machine so I can't test it
Here is a screenshot of forbidden char message

I will create a custom build to test on Windows machine later

On windows I have freetube-playlist-Special_!@#$_^&_()-_=+[]{};_'_.______List-2024-10-07.db, same as MacOS

PikachuEXE

I assume Linux is fine

PikachuEXE · 2024-10-10T00:23:12Z

@efb4f5ff-1298-471a-8973-3d47447115dc @absidue 👋

efb4f5ff-1298-471a-8973-3d47447115dc

Dont show the export button when playlist has no videos in it.
Move the export button to right of the green copy playlists button so that all the green and red buttons are grouped correctly
Discussion topic: Maybe this closes the issue. I know we dont have a "Import one Playlist button" but now we provide a way to export one playlist. So doesnt that automatically mean that the user can also import one playlist?

PikachuEXE · 2024-10-12T08:03:46Z

I know we dont have a "Import one Playlist button" but now we provide a way to export one playlist. So doesnt that automatically mean that the user can also import one playlist?

I think so

PikachuEXE · 2024-10-27T00:58:53Z

I also see export button on online playlist (which does nothing)
Let me recheck later...

* development: (225 commits) Invidious API: Add support for auto-dubbed audio tracks (FreeTubeApp#5943) Fix settings password handling (FreeTubeApp#5988) Translated using Weblate (Serbian) Translated using Weblate (Breton) Translated using Weblate (Toki Pona) Translated using Weblate (Breton) Translated using Weblate (Toki Pona) Translated using Weblate (Icelandic) Bump youtubei.js from 10.5.0 to 11.0.0 (FreeTubeApp#5996) Bump shaka-player from 4.11.10 to 4.11.11 (FreeTubeApp#5995) Bump eslint-plugin-vue from 9.29.1 to 9.30.0 in the eslint group (FreeTubeApp#5994) Translated using Weblate (Latvian) Translated using Weblate (Toki Pona) Translated using Weblate (Icelandic) Translated using Weblate (Hungarian) Translated using Weblate (Toki Pona) Translated using Weblate (Icelandic) Translated using Weblate (Hungarian) Migrate FtListChannel and FtListHashtag to the composition API (FreeTubeApp#5945) Fix issue FreeTubeApp#5969 (FreeTubeApp#5970) ...

…ove it before "remove duplicate" button

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-10-30T10:58:46Z

src/renderer/components/playlist-info/playlist-info.js

@@ -275,7 +285,6 @@ export default defineComponent({
      // Only online playlists can be shared
      if (this.isUserPlaylist) { return false }

-      // Cannot delete protected playlist


why was this removed?

PikachuEXE · 2024-11-04T01:24:18Z

@ChunkyProgrammer Though I can approve it but if you have time I rather have you take a look :)
Or I will just (partially self-)approve tomorrow

ChunkyProgrammer · 2024-11-04T01:35:34Z

src/renderer/components/playlist-info/playlist-info.js

@@ -412,6 +421,41 @@ export default defineComponent({
      showToast(this.playlistDeletionDisabledLabel)
    },

+    handlePlaylistExport: async function () {
+      const dateStr = getTodayDateStrLocalTimezone()
+      const title = this.selectedUserPlaylist.playlistName.replaceAll(' ', '_').replaceAll(/["%*/:<>?\\|]/g, '_')


Non-blocking: Maybe we should merge the logic here with the logic for replacing the names of files created for screenshots?

FreeTube/src/renderer/helpers/utils.js

Line 565 in 94fe62a

export function replaceFilenameForbiddenChars(filenameOriginal) {

* development: (153 commits) Migrate FtTimestampCatcher to the composition API (FreeTubeApp#6064) Translated using Weblate (Polish) Added functionality to export a single playlist (FreeTubeApp#5779) Fix video player displaying a vertical scrollbar when context menu outside player container (FreeTubeApp#6075) Fix use of deprecated Invidious route on the videos subscription tab (FreeTubeApp#6057) Apply active FreeTube theme to shaka-player menus (FreeTubeApp#5986) Bump sass from 1.80.4 to 1.80.6 (FreeTubeApp#6071) Bump mini-css-extract-plugin from 2.9.1 to 2.9.2 (FreeTubeApp#6068) Translated using Weblate (Vietnamese) Bump webpack from 5.95.0 to 5.96.1 (FreeTubeApp#6069) Translated using Weblate (Vietnamese) Bump sass-loader from 16.0.2 to 16.0.3 (FreeTubeApp#6070) Bump lefthook from 1.8.1 to 1.8.2 (FreeTubeApp#6067) Bump the eslint group with 2 updates (FreeTubeApp#6066) Bump youtubei.js from 11.0.0 to 11.0.1 (FreeTubeApp#6072) Migrate PasswordSettings and PasswordDialog to the composition API (FreeTubeApp#6036) Add some missing jsdoc comments, add jsdoc eslint plugin (FreeTubeApp#6048) Fix shortcut for macOS setting shortcut in video page (FreeTubeApp#6054) Use decodingInfo's powerEfficient property when picking streams (FreeTubeApp#6061) Translated using Weblate (Afrikaans) ...

Added functionality to export a single playlist

b0ad1f5

github-actions bot added the PR: waiting for review For PRs that are complete, tested, and ready for review label Oct 1, 2024

FreeTubeBot enabled auto-merge (squash) October 1, 2024 16:35

efb4f5ff-1298-471a-8973-3d47447115dc requested review from PikachuEXE and absidue October 1, 2024 16:54

PikachuEXE reviewed Oct 2, 2024

View reviewed changes

src/renderer/components/playlist-info/playlist-info.js Outdated Show resolved Hide resolved

Changed whitespace replacement in export file names to underscore

cc80b9e

Co-authored-by: PikachuEXE <git@pikachuexe.net>

auto-merge was automatically disabled October 2, 2024 07:30
Head branch was pushed to by a user without write access

FreeTubeBot enabled auto-merge (squash) October 2, 2024 07:31

Added regular expression to replace common forbidden characters in ex…

563c1ac

…port file name

auto-merge was automatically disabled October 2, 2024 07:33
Head branch was pushed to by a user without write access

FreeTubeBot enabled auto-merge (squash) October 2, 2024 07:33

Optimized regex for replacing illegal characters in file names

14b9a0d

auto-merge was automatically disabled October 2, 2024 07:36
Head branch was pushed to by a user without write access

FreeTubeBot enabled auto-merge (squash) October 2, 2024 07:36

Prefer replaceAll over replace

ce443a8

auto-merge was automatically disabled October 2, 2024 07:39
Head branch was pushed to by a user without write access

FreeTubeBot enabled auto-merge (squash) October 2, 2024 07:39

ChunkyProgrammer requested review from PikachuEXE, efb4f5ff-1298-471a-8973-3d47447115dc and ChunkyProgrammer October 6, 2024 13:48

PikachuEXE reviewed Oct 7, 2024

View reviewed changes

PikachuEXE previously approved these changes Oct 8, 2024

View reviewed changes

efb4f5ff-1298-471a-8973-3d47447115dc requested changes Oct 12, 2024

View reviewed changes

efb4f5ff-1298-471a-8973-3d47447115dc added PR: changes requested and removed PR: waiting for review For PRs that are complete, tested, and ready for review labels Oct 12, 2024

* Make button hidden for online playlist, local playlist w/o video, m…

a530db6

…ove it before "remove duplicate" button

PikachuEXE dismissed their stale review via a530db6 October 29, 2024 01:17

efb4f5ff-1298-471a-8973-3d47447115dc added PR: waiting for review For PRs that are complete, tested, and ready for review and removed PR: changes requested labels Oct 30, 2024

efb4f5ff-1298-471a-8973-3d47447115dc reviewed Oct 30, 2024

View reviewed changes

efb4f5ff-1298-471a-8973-3d47447115dc approved these changes Oct 30, 2024

View reviewed changes

PikachuEXE requested review from absidue and ChunkyProgrammer and removed request for absidue and ChunkyProgrammer October 31, 2024 00:00

absidue approved these changes Nov 3, 2024

View reviewed changes

ChunkyProgrammer approved these changes Nov 4, 2024

View reviewed changes

FreeTubeBot merged commit d3b6563 into FreeTubeApp:development Nov 4, 2024
5 checks passed

github-actions bot removed the PR: waiting for review For PRs that are complete, tested, and ready for review label Nov 4, 2024

PikachuEXE mentioned this pull request Nov 4, 2024

Make playlist import match existing playlist by ID first #6094

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added functionality to export a single playlist #5779

Added functionality to export a single playlist #5779

Zeabyte commented Oct 1, 2024 •

edited by efb4f5ff-1298-471a-8973-3d47447115dc

Loading

PikachuEXE Oct 7, 2024

Zeabyte Oct 7, 2024

PikachuEXE Oct 7, 2024

PikachuEXE Oct 8, 2024

PikachuEXE left a comment

PikachuEXE commented Oct 10, 2024

efb4f5ff-1298-471a-8973-3d47447115dc left a comment

PikachuEXE commented Oct 12, 2024

PikachuEXE commented Oct 27, 2024

efb4f5ff-1298-471a-8973-3d47447115dc Oct 30, 2024

PikachuEXE commented Nov 4, 2024

ChunkyProgrammer Nov 4, 2024

Added functionality to export a single playlist #5779

Added functionality to export a single playlist #5779

Conversation

Zeabyte commented Oct 1, 2024 • edited by efb4f5ff-1298-471a-8973-3d47447115dc Loading

Single Playlist Export

Pull Request Type

Related issue

Description

Screenshots

Testing

Desktop

Additional context

PikachuEXE Oct 7, 2024

Choose a reason for hiding this comment

Zeabyte Oct 7, 2024

Choose a reason for hiding this comment

PikachuEXE Oct 7, 2024

Choose a reason for hiding this comment

PikachuEXE Oct 8, 2024

Choose a reason for hiding this comment

PikachuEXE left a comment

Choose a reason for hiding this comment

PikachuEXE commented Oct 10, 2024

efb4f5ff-1298-471a-8973-3d47447115dc left a comment

Choose a reason for hiding this comment

PikachuEXE commented Oct 12, 2024

PikachuEXE commented Oct 27, 2024

efb4f5ff-1298-471a-8973-3d47447115dc Oct 30, 2024

Choose a reason for hiding this comment

PikachuEXE commented Nov 4, 2024

ChunkyProgrammer Nov 4, 2024

Choose a reason for hiding this comment

Zeabyte commented Oct 1, 2024 •

edited by efb4f5ff-1298-471a-8973-3d47447115dc

Loading