1 files changed, 317 insertions, 0 deletions
diff --git a/subsonic-main/src/main/java/net/sourceforge/subsonic/service/PlayerService.java b/subsonic-main/src/main/java/net/sourceforge/subsonic/service/PlayerService.java
new file mode 100644
index 00000000..0f24b2b8
--- /dev/null
+++ b/subsonic-main/src/main/java/net/sourceforge/subsonic/service/PlayerService.java
@@ -0,0 +1,317 @@
+/*
+ This file is part of Subsonic.
+
+ Subsonic is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Subsonic is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Subsonic.  If not, see <http://www.gnu.org/licenses/>.
+
+ Copyright 2009 (C) Sindre Mehus
+ */
+package net.sourceforge.subsonic.service;
+
+import net.sourceforge.subsonic.dao.PlayerDao;
+import net.sourceforge.subsonic.domain.Player;
+import net.sourceforge.subsonic.domain.Transcoding;
+import net.sourceforge.subsonic.domain.TransferStatus;
+import net.sourceforge.subsonic.util.StringUtil;
+import org.apache.commons.lang.StringUtils;
+
+import javax.servlet.http.Cookie;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * Provides services for maintaining the set of players.
+ *
+ * @author Sindre Mehus
+ * @see Player
+ */
+public class PlayerService {
+
+    private static final String COOKIE_NAME = "player";
+    private static final int COOKIE_EXPIRY = 365 * 24 * 3600; // One year
+
+    private PlayerDao playerDao;
+    private StatusService statusService;
+    private SecurityService securityService;
+    private TranscodingService transcodingService;
+
+    public void init() {
+        playerDao.deleteOldPlayers(60);
+    }
+
+    /**
+     * Equivalent to <code>getPlayer(request, response, true)</code> .
+     */
+    public Player getPlayer(HttpServletRequest request, HttpServletResponse response) {
+        return getPlayer(request, response, true, false);
+    }
+
+    /**
+     * Returns the player associated with the given HTTP request.  If no such player exists, a new
+     * one is created.
+     *
+     * @param request              The HTTP request.
+     * @param response             The HTTP response.
+     * @param remoteControlEnabled Whether this method should return a remote-controlled player.
+     * @param isStreamRequest      Whether the HTTP request is a request for streaming data.
+     * @return The player associated with the given HTTP request.
+     */
+    public synchronized Player getPlayer(HttpServletRequest request, HttpServletResponse response,
+                                         boolean remoteControlEnabled, boolean isStreamRequest) {
+
+        // Find by 'player' request parameter.
+        Player player = getPlayerById(request.getParameter("player"));
+
+        // Find in session context.
+        if (player == null && remoteControlEnabled) {
+            String playerId = (String) request.getSession().getAttribute("player");
+            if (playerId != null) {
+                player = getPlayerById(playerId);
+            }
+        }
+
+        // Find by cookie.
+        String username = securityService.getCurrentUsername(request);
+        if (player == null && remoteControlEnabled) {
+            player = getPlayerById(getPlayerIdFromCookie(request, username));
+        }
+
+        // Make sure we're not hijacking the player of another user.
+        if (player != null && player.getUsername() != null && username != null && !player.getUsername().equals(username)) {
+            player = null;
+        }
+
+        // Look for player with same IP address and user name.
+        if (player == null) {
+            player = getPlayerByIpAddressAndUsername(request.getRemoteAddr(), username);
+
+            // Don't use this player if it's used by REST API.
+            if (player != null && player.getClientId() != null) {
+                player = null;
+            }
+        }
+
+        // If no player was found, create it.
+        if (player == null) {
+            player = new Player();
+            createPlayer(player);
+//            LOG.debug("Created player " + player.getId() + " (remoteControlEnabled: " + remoteControlEnabled +
+//                      ", isStreamRequest: " + isStreamRequest + ", username: " + username +
+//                      ", ip: " + request.getRemoteAddr() + ").");
+        }
+
+        // Update player data.
+        boolean isUpdate = false;
+        if (username != null && player.getUsername() == null) {
+            player.setUsername(username);
+            isUpdate = true;
+        }
+        if (player.getIpAddress() == null || isStreamRequest ||
+            (!isPlayerConnected(player) && player.isDynamicIp() && !request.getRemoteAddr().equals(player.getIpAddress()))) {
+            player.setIpAddress(request.getRemoteAddr());
+            isUpdate = true;
+        }
+        String userAgent = request.getHeader("user-agent");
+        if (isStreamRequest) {
+            player.setType(userAgent);
+            player.setLastSeen(new Date());
+            isUpdate = true;
+        }
+
+        if (isUpdate) {
+            updatePlayer(player);
+        }
+
+        // Set cookie in response.
+        if (response != null) {
+            String cookieName = COOKIE_NAME + "-" + StringUtil.utf8HexEncode(username);
+            Cookie cookie = new Cookie(cookieName, player.getId());
+            cookie.setMaxAge(COOKIE_EXPIRY);
+            String path = request.getContextPath();
+            if (StringUtils.isEmpty(path)) {
+                path = "/";
+            }
+            cookie.setPath(path);
+            response.addCookie(cookie);
+        }
+
+        // Save player in session context.
+        if (remoteControlEnabled) {
+            request.getSession().setAttribute("player", player.getId());
+        }
+
+        return player;
+    }
+
+    /**
+     * Updates the given player.
+     *
+     * @param player The player to update.
+     */
+    public void updatePlayer(Player player) {
+        playerDao.updatePlayer(player);
+    }
+
+    /**
+     * Returns the player with the given ID.
+     *
+     * @param id The unique player ID.
+     * @return The player with the given ID, or <code>null</code> if no such player exists.
+     */
+    public Player getPlayerById(String id) {
+        return playerDao.getPlayerById(id);
+    }
+
+    /**
+     * Returns whether the given player is connected.
+     *
+     * @param player The player in question.
+     * @return Whether the player is connected.
+     */
+    private boolean isPlayerConnected(Player player) {
+        for (TransferStatus status : statusService.getStreamStatusesForPlayer(player)) {
+            if (status.isActive()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Returns the player with the given IP address and username. If no username is given, only IP address is
+     * used as search criteria.
+     *
+     * @param ipAddress The IP address.
+     * @param username  The remote user.
+     * @return The player with the given IP address, or <code>null</code> if no such player exists.
+     */
+    private Player getPlayerByIpAddressAndUsername(final String ipAddress, final String username) {
+        if (ipAddress == null) {
+            return null;
+        }
+        for (Player player : getAllPlayers()) {
+            boolean ipMatches = ipAddress.equals(player.getIpAddress());
+            boolean userMatches = username == null || username.equals(player.getUsername());
+            if (ipMatches && userMatches) {
+                return player;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Reads the player ID from the cookie in the HTTP request.
+     *
+     * @param request  The HTTP request.
+     * @param username The name of the current user.
+     * @return The player ID embedded in the cookie, or <code>null</code> if cookie is not present.
+     */
+    private String getPlayerIdFromCookie(HttpServletRequest request, String username) {
+        Cookie[] cookies = request.getCookies();
+        if (cookies == null) {
+            return null;
+        }
+        String cookieName = COOKIE_NAME + "-" + StringUtil.utf8HexEncode(username);
+        for (Cookie cookie : cookies) {
+            if (cookieName.equals(cookie.getName())) {
+                return cookie.getValue();
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Returns all players owned by the given username and client ID.
+     *
+     * @param username The name of the user.
+     * @param clientId The third-party client ID (used if this player is managed over the
+     *                 Subsonic REST API). May be <code>null</code>.
+     * @return All relevant players.
+     */
+    public List<Player> getPlayersForUserAndClientId(String username, String clientId) {
+        return playerDao.getPlayersForUserAndClientId(username, clientId);
+    }
+
+    /**
+     * Returns all currently registered players.
+     *
+     * @return All currently registered players.
+     */
+    public List<Player> getAllPlayers() {
+        return playerDao.getAllPlayers();
+    }
+
+    /**
+     * Removes the player with the given ID.
+     *
+     * @param id The unique player ID.
+     */
+    public synchronized void removePlayerById(String id) {
+        playerDao.deletePlayer(id);
+    }
+
+    /**
+     * Creates and returns a clone of the given player.
+     *
+     * @param playerId The ID of the player to clone.
+     * @return The cloned player.
+     */
+    public Player clonePlayer(String playerId) {
+        Player player = getPlayerById(playerId);
+        if (player.getName() != null) {
+            player.setName(player.getName() + " (copy)");
+        }
+
+        createPlayer(player);
+        return player;
+    }
+
+    /**
+     * Creates the given player, and activates all transcodings.
+     *
+     * @param player The player to create.
+     */
+    public void createPlayer(Player player) {
+        playerDao.createPlayer(player);
+
+        List<Transcoding> transcodings = transcodingService.getAllTranscodings();
+        List<Transcoding> defaultActiveTranscodings = new ArrayList<Transcoding>();
+        for (Transcoding transcoding : transcodings) {
+            if (transcoding.isDefaultActive()) {
+                defaultActiveTranscodings.add(transcoding);
+            }
+        }
+
+        transcodingService.setTranscodingsForPlayer(player, defaultActiveTranscodings);
+    }
+
+    public void setStatusService(StatusService statusService) {
+        this.statusService = statusService;
+    }
+
+    public void setSecurityService(SecurityService securityService) {
+        this.securityService = securityService;
+    }
+
+    public void setPlayerDao(PlayerDao playerDao) {
+        this.playerDao = playerDao;
+    }
+
+    public void setTranscodingService(TranscodingService transcodingService) {
+        this.transcodingService = transcodingService;
+    }
+}