1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
# This file is part of beets.
# Copyright 2016, Fabrice Laporte.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
"""Write paths of imported files in various formats to ease later import in a
music player. Also allow printing the new file locations to stdout in case
one wants to manually add music to a player by its path.
"""
import datetime
import os
import re
from beets import config
from beets.plugins import BeetsPlugin
from beets.util import bytestring_path, link, mkdirall, normpath, syspath
M3U_DEFAULT_NAME = "imported.m3u"
def _build_m3u_session_filename(basename):
"""Builds unique m3u filename by putting current date between given
basename and file ending."""
date = datetime.datetime.now().strftime("%Y%m%d_%Hh%M")
basename = re.sub(r"(\.m3u|\.M3U)", "", basename)
path = normpath(
os.path.join(
config["importfeeds"]["dir"].as_filename(), f"{basename}_{date}.m3u"
)
)
return path
def _build_m3u_filename(basename):
"""Builds unique m3u filename by appending given basename to current
date."""
basename = re.sub(r"[\s,/\\'\"]", "_", basename)
date = datetime.datetime.now().strftime("%Y%m%d_%Hh%M")
path = normpath(
os.path.join(
config["importfeeds"]["dir"].as_filename(),
f"{date}_{basename}.m3u",
)
)
return path
def _write_m3u(m3u_path, items_paths):
"""Append relative paths to items into m3u file."""
mkdirall(m3u_path)
with open(syspath(m3u_path), "ab") as f:
for path in items_paths:
f.write(path + b"\n")
class ImportFeedsPlugin(BeetsPlugin):
def __init__(self):
super().__init__()
self.config.add(
{
"formats": [],
"m3u_name": "imported.m3u",
"dir": None,
"relative_to": None,
"absolute_path": False,
}
)
relative_to = self.config["relative_to"].get()
if relative_to:
self.config["relative_to"] = normpath(relative_to)
else:
self.config["relative_to"] = self.get_feeds_dir()
self.register_listener("album_imported", self.album_imported)
self.register_listener("item_imported", self.item_imported)
self.register_listener("import_begin", self.import_begin)
def get_feeds_dir(self):
feeds_dir = self.config["dir"].get()
if feeds_dir:
return os.path.expanduser(bytestring_path(feeds_dir))
return config["directory"].as_filename()
def _record_items(self, lib, basename, items):
"""Records relative paths to the given items for each feed format"""
feedsdir = bytestring_path(self.get_feeds_dir())
formats = self.config["formats"].as_str_seq()
relative_to = self.config["relative_to"].get() or self.get_feeds_dir()
relative_to = bytestring_path(relative_to)
paths = []
for item in items:
if self.config["absolute_path"]:
paths.append(item.path)
else:
try:
relpath = os.path.relpath(item.path, relative_to)
except ValueError:
# On Windows, it is sometimes not possible to construct a
# relative path (if the files are on different disks).
relpath = item.path
paths.append(relpath)
if "m3u" in formats:
m3u_basename = bytestring_path(self.config["m3u_name"].as_str())
m3u_path = os.path.join(feedsdir, m3u_basename)
_write_m3u(m3u_path, paths)
if "m3u_session" in formats:
m3u_path = os.path.join(feedsdir, self.m3u_session)
_write_m3u(m3u_path, paths)
if "m3u_multi" in formats:
m3u_path = _build_m3u_filename(basename)
_write_m3u(m3u_path, paths)
if "link" in formats:
for path in paths:
dest = os.path.join(feedsdir, os.path.basename(path))
if not os.path.exists(syspath(dest)):
link(path, dest)
if "echo" in formats:
self._log.info("Location of imported music:")
for path in paths:
self._log.info(" {}", path)
def album_imported(self, lib, album):
self._record_items(lib, album.album, album.items())
def item_imported(self, lib, item):
self._record_items(lib, item.title, [item])
def import_begin(self, session):
formats = self.config["formats"].as_str_seq()
if "m3u_session" in formats:
self.m3u_session = _build_m3u_session_filename(
self.config["m3u_name"].as_str()
)
|
