initial commit

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

README.md

@@ -0,0 +1,10 @@
+A music organizer for your legally obtained songs. Tested with songs from [SpotiFLAC](https://github.com/afkarxyz/SpotiFLAC).
+
+The library is structured as: `ArtistName/AlbumName/Title.flac`.
+
+# Usage
+
+Currently there are two subcommands:
+
+- `info` Displays information about the song.
+- `sort` Copy the song into the sorted library.

cmd/ripsort.go

@@ -0,0 +1,34 @@
+package cmd
+
+import (
+	ripsort "git.kapelle.org/niklas/ripsort/internal"
+	"github.com/alexflint/go-arg"
+)
+
+type InfoCmd struct {
+	File string `arg:"positional,required"`
+}
+
+type SortCmd struct {
+	Dst  string `arg:"positional,required"`
+	Path string `arg:"positional,required"`
+}
+
+type args struct {
+	Info *InfoCmd `arg:"subcommand:info"`
+	Sort *SortCmd `arg:"subcommand:sort"`
+}
+
+func Run() {
+	var args args
+	p := arg.MustParse(&args)
+
+	switch {
+	case args.Info != nil:
+		ripsort.Scan(args.Info.File)
+	case args.Sort != nil:
+		ripsort.Sort(args.Sort.Dst, args.Sort.Path)
+	default:
+		p.Fail("Must specify command")
+	}
+}

go.mod

@@ -0,0 +1,9 @@
+module git.kapelle.org/niklas/ripsort
+
+go 1.25.7
+
+require (
+	github.com/alexflint/go-arg v1.6.1 // indirect
+	github.com/alexflint/go-scalar v1.2.0 // indirect
+	github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 // indirect
+)

go.sum

@@ -0,0 +1,9 @@
+github.com/alexflint/go-arg v1.6.1 h1:uZogJ6VDBjcuosydKgvYYRhh9sRCusjOvoOLZopBlnA=
+github.com/alexflint/go-arg v1.6.1/go.mod h1:nQ0LFYftLJ6njcaee0sU+G0iS2+2XJQfA8I062D0LGc=
+github.com/alexflint/go-scalar v1.2.0 h1:WR7JPKkeNpnYIOfHRa7ivM21aWAdHD0gEWHCx+WQBRw=
+github.com/alexflint/go-scalar v1.2.0/go.mod h1:LoFvNMqS1CPrMVltza4LvnGKhaSpc3oyLEBUZVhhS2o=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 h1:OtSeLS5y0Uy01jaKK4mA/WVIYtpzVm63vLVAPzJXigg=
+github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8/go.mod h1:apkPC/CR3s48O2D7Y++n1XWEpgPNNCjXYga3PPbJe2E=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=

internal/metadata.go

@@ -0,0 +1,65 @@
+package ripsort
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/dhowden/tag"
+)
+
+type metadata struct {
+	Format      tag.Format
+	FileType    tag.FileType
+	Title       string
+	Artist      []string
+	Album       string
+	AlbumArtist []string
+	Composer    []string
+	Genre       string
+	Year        int
+	Track       int
+	TotalTracks int
+	Disc        int
+	TotalDiscs  int
+	Lyrics      string
+	Comment     string
+	HasPicture  bool
+}
+
+func ReadAudioTags(filePath string) (*metadata, error) {
+	f, err := os.Open(filePath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open file: %w", err)
+	}
+	defer f.Close()
+
+	m, err := tag.ReadFrom(f)
+	if err != nil {
+		return nil, fmt.Errorf("failed to read tags: %w", err)
+	}
+
+	track, totalTracks := m.Track()
+	disc, totalDiscs := m.Disc()
+
+	info := &metadata{
+		Format:      m.Format(),
+		FileType:    m.FileType(),
+		Title:       m.Title(),
+		Artist:      strings.Split(m.Artist(), ";"),
+		Album:       m.Album(),
+		AlbumArtist: strings.Split(m.AlbumArtist(), ";"),
+		Composer:    strings.Split(m.Composer(), ";"),
+		Genre:       m.Genre(),
+		Year:        m.Year(),
+		Track:       track,
+		TotalTracks: totalTracks,
+		Disc:        disc,
+		TotalDiscs:  totalDiscs,
+		Lyrics:      m.Lyrics(),
+		Comment:     m.Comment(),
+		HasPicture:  m.Picture() != nil,
+	}
+
+	return info, nil
+}

internal/ripsort.go

@@ -0,0 +1,72 @@
+package ripsort
+
+import (
+	"fmt"
+	"io/fs"
+	"log/slog"
+	"os"
+	"path/filepath"
+)
+
+func Scan(filePath string) {
+	info, err := ReadAudioTags(filePath)
+
+	if err != nil {
+		slog.Error("Reading metadata", "file", filePath, "err", err)
+		os.Exit(1)
+	}
+
+	fmt.Printf("Format:       %v\n", info.Format)
+	fmt.Printf("File Type:    %v\n", info.FileType)
+	fmt.Printf("Title:        %s\n", info.Title)
+	fmt.Printf("Artist:       %s\n", info.Artist)
+	fmt.Printf("Album:        %s\n", info.Album)
+	fmt.Printf("Album Artist: %s\n", info.AlbumArtist)
+	fmt.Printf("Composer:     %s\n", info.Composer)
+	fmt.Printf("Genre:        %s\n", info.Genre)
+	fmt.Printf("Year:         %d\n", info.Year)
+	fmt.Printf("Track:        %d/%d\n", info.Track, info.TotalTracks)
+	fmt.Printf("Disc:         %d/%d\n", info.Disc, info.TotalDiscs)
+	fmt.Printf("Lyrics:       %s\n", info.Lyrics)
+	fmt.Printf("Comment:      %s\n", info.Comment)
+	fmt.Printf("Has Picture:  %v\n", info.HasPicture)
+
+	sortPath := pathForFile(filePath, *info)
+	fmt.Printf("Sort path:    %s\n", sortPath)
+}
+
+func Sort(dst, path string) {
+	info, err := os.Stat(path)
+	if err != nil {
+		slog.Error("Failed to stat path", "file", path, "err", err)
+		os.Exit(1)
+	}
+
+	if !info.IsDir() {
+		if err := sortSong(path, dst); err != nil {
+			slog.Error("Failed to sort single file", "file", path, "err", err)
+			os.Exit(1)
+		}
+		return
+	}
+
+	err = filepath.WalkDir(path, func(p string, d fs.DirEntry, err error) error {
+		if err != nil {
+			slog.Error("Failed to walk path", "path", path, "file", p, "err", err)
+			return err
+		}
+
+		if !d.IsDir() {
+			if err := sortSong(p, dst); err != nil {
+				slog.Error("Failed to sort file", "file", p, "err", err)
+				return err
+			}
+		}
+
+		return nil
+	})
+
+	if err != nil {
+		os.Exit(1)
+	}
+}

internal/sorter.go

@@ -0,0 +1,125 @@
+package ripsort
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+func sortSong(src, dst string) error {
+	m, err := ReadAudioTags(src)
+	if err != nil {
+		return err
+	}
+
+	dstPath := pathForFile(src, *m)
+	finalPath := filepath.Join(dst, dstPath)
+
+	err = copyFile(src, finalPath)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func sanitizeName(name string) *string {
+	if name == "" {
+		return nil
+	}
+
+	re := regexp.MustCompile(`[<>:"/\\|?*\x00-\x1F]`)
+	name = re.ReplaceAllString(name, "_")
+
+	name = strings.Trim(name, " .")
+
+	if name == "" {
+		return nil
+	}
+
+	return &name
+}
+
+func getArtistName(m metadata) string {
+	var artist *string
+
+	if len(m.Artist) > 0 {
+		artist = sanitizeName(m.Artist[0])
+	}
+
+	if artist == nil && len(m.AlbumArtist) > 0 {
+		if aa := m.AlbumArtist[0]; aa != "" {
+			artist = sanitizeName(aa)
+		}
+	}
+
+	if artist == nil {
+		return "Unknown Artist"
+	}
+
+	return *artist
+}
+
+func getAlbumName(m metadata) string {
+	album := sanitizeName(m.Album)
+	if album == nil {
+		return "Unknown Album"
+	}
+	return *album
+}
+
+func getTitle(src string, m metadata) string {
+	title := sanitizeName(m.Title)
+	if title == nil {
+		return *sanitizeName(strings.TrimSuffix(filepath.Base(src), filepath.Ext(src)))
+	}
+	return *title
+}
+
+func pathForFile(src string, m metadata) string {
+	ext := strings.ToLower(filepath.Ext(src))
+
+	artist := getArtistName(m)
+	album := getAlbumName(m)
+	title := getTitle(src, m)
+
+	filename := title + ext
+
+	return filepath.Join(artist, album, filename)
+}
+
+func copyFile(src, dst string) error {
+	in, err := os.Open(src)
+	if err != nil {
+		return fmt.Errorf("open source file: %w", err)
+	}
+	defer in.Close()
+
+	dir := filepath.Dir(dst)
+	if err := os.MkdirAll(dir, 0o755); err != nil {
+		return fmt.Errorf("create destination directory: %w", err)
+	}
+
+	out, err := os.Create(dst)
+	if err != nil {
+		return fmt.Errorf("create destination file: %w", err)
+	}
+	defer func() {
+		if cerr := out.Close(); err == nil && cerr != nil {
+			err = cerr
+		}
+	}()
+
+	if _, err = io.Copy(out, in); err != nil {
+		return fmt.Errorf("copy file contents: %w", err)
+	}
+
+	if err = out.Sync(); err != nil {
+		return fmt.Errorf("sync destination file: %w", err)
+	}
+
+	return nil
+}

main.go

@@ -0,0 +1,7 @@
+package main
+
+import "git.kapelle.org/niklas/ripsort/cmd"
+
+func main(){
+	cmd.Run()
+}