def copy_playlist(playlist_mbid):
"""
Copy a playlist -- the new playlist will be given the name "Copy of <playlist_name>".
POST body data does not need to contain anything.
:reqheader Authorization: Token <user token>
:statuscode 200: playlist copied.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 404: Playlist not found
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid)
if playlist is None or not playlist.is_visible_by(user["id"]):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
try:
new_playlist = db_playlist.copy_playlist(playlist, user["id"])
except Exception as e:
current_app.logger.error("Error copying playlist: {}".format(e))
raise APIInternalServerError("Failed to copy the playlist. Please try again.")
return jsonify({'status': 'ok', 'playlist_mbid': new_playlist.mbid})
def get_playlist(playlist_mbid):
"""
Fetch the given playlist.
:param playlist_mbid: Optional, The playlist mbid to fetch.
:statuscode 200: Yay, you have data!
:statuscode 404: Playlist not found
:statuscode 401: Invalid authorization. See error message for details.
:resheader Content-Type: *application/json*
"""
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid, True)
if playlist is None:
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if not playlist.public:
user = validate_auth_header()
if playlist.creator_id != user["id"]:
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
fetch_playlist_recording_metadata(playlist)
return jsonify(serialize_jspf(playlist))
def delete_playlist(playlist_mbid):
"""
Delete a playlist. POST body data does not need to contain anything.
:reqheader Authorization: Token <user token>
:statuscode 200: playlist deleted.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 403: forbidden. the requesting user was not allowed to carry out this operation.
:statuscode 404: Playlist not found
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid)
if playlist is None or not playlist.is_visible_by(user["id"]):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if playlist.creator_id != user["id"]:
raise APIForbidden("You are not allowed to delete this playlist.")
try:
db_playlist.delete_playlist(playlist)
except Exception as e:
current_app.logger.error("Error deleting playlist: {}".format(e))
raise APIInternalServerError("Failed to delete the playlist. Please try again.")
return jsonify({'status': 'ok'})
def get_playlist(playlist_mbid):
"""
Fetch the given playlist.
:param playlist_mbid: The playlist mbid to fetch.
:type playlist_mbid: ``str``
:param fetch_metadata: Optional, pass value 'false' to skip lookup up recording metadata
:type fetch_metadata: ``bool``
:statuscode 200: Yay, you have data!
:statuscode 404: Playlist not found
:statuscode 401: Invalid authorization. See error message for details.
:resheader Content-Type: *application/json*
"""
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
fetch_metadata = parse_boolean_arg("fetch_metadata", True)
playlist = db_playlist.get_by_mbid(playlist_mbid, True)
if playlist is None:
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
user = validate_auth_header(optional=True)
user_id = None
if user:
user_id = user["id"]
if not playlist.is_visible_by(user_id):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if fetch_metadata:
fetch_playlist_recording_metadata(playlist)
return jsonify(serialize_jspf(playlist))
def load_playlist(playlist_mbid: str):
"""Load a single playlist by id
"""
if not is_valid_uuid(playlist_mbid):
raise BadRequest("Provided playlist ID is invalid: %s" % playlist_mbid)
playlist = db_playlist.get_by_mbid(playlist_mbid, True)
# TODO: Allow playlist collaborators to access private playlist
if playlist is None or not playlist.public and (not current_user.is_authenticated or playlist.creator_id != current_user.id):
raise NotFound("Cannot find playlist: %s" % playlist_mbid)
fetch_playlist_recording_metadata(playlist)
spotify_data = {}
current_user_data = {}
if current_user.is_authenticated:
spotify_data = spotify.get_user_dict(current_user.id)
current_user_data = {
"id": current_user.id,
"name": current_user.musicbrainz_id,
"auth_token": current_user.auth_token,
}
props = {
"current_user": current_user_data,
"spotify": spotify_data,
"api_url": current_app.config["API_URL"],
"web_sockets_server_url": current_app.config['WEBSOCKETS_SERVER_URL'],
"playlist": serialize_jspf(playlist)
}
return render_template(
"playlists/playlist.html",
props=ujson.dumps(props)
)
def add_playlist_item(playlist_mbid, offset):
"""
Append recordings to an existing playlist by posting a playlist with one of more recordings in it.
The playlist must be in JSPF format with MusicBrainz extensions, which is defined here:
https://musicbrainz.org/doc/jspf .
If the offset is provided in the URL, then the recordings will be added at that offset,
otherwise they will be added at the end of the playlist.
You may only add :data:`~webserver.views.playlist_api.MAX_RECORDINGS_PER_ADD` recordings in one
call to this endpoint.
:reqheader Authorization: Token <user token>
:statuscode 200: playlist accepted.
:statuscode 400: invalid JSON sent, see error message for details.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 403: forbidden. the requesting user was not allowed to carry out this operation.
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
if offset is not None and offset < 0:
log_raise_400("Offset must be a positive integer.")
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid)
if playlist is None or not playlist.is_visible_by(user["id"]):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if not playlist.is_modifiable_by(user["id"]):
raise APIForbidden("You are not allowed to add recordings to this playlist.")
data = request.json
validate_playlist(data)
if len(data["playlist"]["track"]) > MAX_RECORDINGS_PER_ADD:
log_raise_400("You may only add max %d recordings per call." % MAX_RECORDINGS_PER_ADD)
precordings = []
if "track" in data["playlist"]:
for track in data["playlist"]["track"]:
try:
mbid = UUID(track['identifier'][len(PLAYLIST_TRACK_URI_PREFIX):])
except (KeyError, ValueError):
log_raise_400("Track %d has an invalid identifier field, it must be a complete URI.")
precordings.append(WritablePlaylistRecording(mbid=mbid, added_by_id=user["id"]))
try:
db_playlist.add_recordings_to_playlist(playlist, precordings, offset)
except Exception as e:
current_app.logger.error("Error while adding recordings to playlist: {}".format(e))
raise APIInternalServerError("Failed to add recordings to the playlist. Please try again.")
return jsonify({'status': 'ok'})
def joined(data):
if 'playlist_id' not in data:
raise BadRequest("Missing key 'playlist_id'")
playlist_mbid = data['playlist_id']
playlist = db_playlist.get_by_mbid(playlist_mbid)
if current_user.is_authenticated and playlist.is_modifiable_by(
current_user.id):
join_room(playlist_mbid)
emit('joined', {'status': 'success'}, to=playlist_mbid)
else:
disconnect()
def move_playlist_item(playlist_mbid):
"""
To move an item in a playlist, the POST data needs to specify the recording MBID and current index
of the track to move (from), where to move it to (to) and how many tracks from that position should
be moved (count). The format of the post data should look as follows:
.. code-block:: json
{
"mbid": "<mbid>",
"from": 3,
"to": 4,
"count": 2
}
:reqheader Authorization: Token <user token>
:statuscode 200: move operation succeeded
:statuscode 400: invalid JSON sent, see error message for details.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 403: forbidden. the requesting user was not allowed to carry out this operation.
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid)
if playlist is None or not playlist.is_visible_by(user["id"]):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if not playlist.is_modifiable_by(user["id"]):
raise APIForbidden(
"You are not allowed to move recordings in this playlist.")
data = request.json
validate_move_data(data)
try:
db_playlist.move_recordings(playlist, data['from'], data['to'],
data['count'])
except Exception as e:
current_app.logger.error(
"Error while moving recordings in the playlist: {}".format(e))
raise APIInternalServerError(
"Failed to move recordings in the playlist. Please try again.")
return jsonify({'status': 'ok'})
def delete_playlist_item(playlist_mbid):
"""
To delete an item in a playlist, the POST data needs to specify the recording MBID and current index
of the track to delete, and how many tracks from that position should be moved deleted. The format of the
post data should look as follows:
.. code-block:: json
{“index” : 3, “count”: 2}
:reqheader Authorization: Token <user token>
:statuscode 200: playlist accepted.
:statuscode 400: invalid JSON sent, see error message for details.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 403: forbidden. the requesting user was not allowed to carry out this operation.
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid)
if playlist is None or \
(playlist.creator_id != user["id"] and not playlist.public):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if playlist.creator_id != user["id"]:
raise APIForbidden(
"You are not allowed to remove recordings from this playlist.")
data = request.json
validate_delete_data(data)
try:
db_playlist.delete_recordings_from_playlist(playlist, data['index'],
data['count'])
except Exception as e:
current_app.logger.error(
"Error while deleting recordings from playlist: {}".format(e))
raise APIInternalServerError(
"Failed to deleting recordings from the playlist. Please try again."
)
return jsonify({'status': 'ok'})
def load_playlist(playlist_mbid: str):
"""Load a single playlist by id
"""
if not is_valid_uuid(playlist_mbid):
raise BadRequest("Provided playlist ID is invalid: %s" % playlist_mbid)
current_user_id = None
if current_user.is_authenticated:
current_user_id = current_user.id
playlist = db_playlist.get_by_mbid(playlist_mbid, True)
if playlist is None or not playlist.is_visible_by(current_user_id):
raise NotFound("Cannot find playlist: %s" % playlist_mbid)
fetch_playlist_recording_metadata(playlist)
spotify_data = {}
current_user_data = {}
if current_user.is_authenticated:
spotify_data = spotify.get_user_dict(current_user.id)
current_user_data = {
"id": current_user.id,
"name": current_user.musicbrainz_id,
"auth_token": current_user.auth_token,
}
props = {
"current_user": current_user_data,
"spotify": spotify_data,
"api_url": current_app.config["API_URL"],
"labs_api_url": current_app.config["LISTENBRAINZ_LABS_API_URL"],
"web_sockets_server_url": current_app.config['WEBSOCKETS_SERVER_URL'],
"playlist": serialize_jspf(playlist),
"sentry_dsn": current_app.config.get("LOG_SENTRY", {}).get("dsn")
}
return render_template(
"playlists/playlist.html",
props=ujson.dumps(props)
)
def load_playlist(playlist_mbid: str):
"""Load a single playlist by id
"""
if not is_valid_uuid(playlist_mbid):
raise BadRequest("Provided playlist ID is invalid: %s" % playlist_mbid)
current_user_id = None
if current_user.is_authenticated:
current_user_id = current_user.id
playlist = db_playlist.get_by_mbid(playlist_mbid, True)
if playlist is None or not playlist.is_visible_by(current_user_id):
raise NotFound("Cannot find playlist: %s" % playlist_mbid)
fetch_playlist_recording_metadata(playlist)
props = {
"labs_api_url": current_app.config["LISTENBRAINZ_LABS_API_URL"],
"web_sockets_server_url": current_app.config['WEBSOCKETS_SERVER_URL'],
"playlist": serialize_jspf(playlist),
}
return render_template("playlists/playlist.html", props=ujson.dumps(props))
def edit_playlist(playlist_mbid):
"""
Edit the private/public status, name, description or list of collaborators for an exising playlist.
The Authorization header must be set and correspond to the owner of the playlist otherwise a 403
error will be returned. All fields will be overwritten with new values.
:reqheader Authorization: Token <user token>
:statuscode 200: playlist accepted.
:statuscode 400: invalid JSON sent, see error message for details.
:statuscode 401: invalid authorization. See error message for details.
:statuscode 403: forbidden. The subitting user is not allowed to edit playlists for other users.
:resheader Content-Type: *application/json*
"""
user = validate_auth_header()
data = request.json
validate_playlist(data)
if not is_valid_uuid(playlist_mbid):
log_raise_400("Provided playlist ID is invalid.")
playlist = db_playlist.get_by_mbid(playlist_mbid, False)
if playlist is None or not playlist.is_visible_by(user["id"]):
raise APINotFound("Cannot find playlist: %s" % playlist_mbid)
if playlist.creator_id != user["id"]:
raise APIForbidden("You are not allowed to edit this playlist.")
try:
playlist.public = data["playlist"]["extension"][PLAYLIST_EXTENSION_URI]["public"]
except KeyError:
pass
if "annotation" in data["playlist"]:
# If the annotation key exists but the value is empty ("" or None),
# unset the description
description = data["playlist"]["annotation"]
if description:
description = _filter_description_html(description)
else:
description = None
playlist.description = description
if data["playlist"].get("title"):
playlist.name = data["playlist"]["title"]
collaborators = data.get("playlist", {}).\
get("extension", {}).get(PLAYLIST_EXTENSION_URI, {}).\
get("collaborators", [])
users = {}
# Uniquify collaborators list
collaborators = list(set(collaborators))
# Don't allow creator to also be a collaborator
if user["musicbrainz_id"] in collaborators:
collaborators.remove(user["musicbrainz_id"])
if collaborators:
users = db_user.get_many_users_by_mb_id(collaborators)
collaborator_ids = []
for collaborator in collaborators:
if collaborator.lower() not in users:
log_raise_400("Collaborator {} doesn't exist".format(collaborator))
collaborator_ids.append(users[collaborator.lower()]["id"])
playlist.collaborators = collaborators
playlist.collaborator_ids = collaborator_ids
db_playlist.update_playlist(playlist)
return jsonify({'status': 'ok'})
