if (!window.MediaBrowser) { window.MediaBrowser = {}; } MediaBrowser.ApiClient = function ($, navigator, JSON, WebSocket, setTimeout) { /** * Creates a new api client instance * @param {String} serverProtocol * @param {String} serverHostName * @param {String} serverPortNumber * @param {String} clientName */ return function (serverProtocol, serverHostName, serverPortNumber, clientName) { if (!serverProtocol) { throw new Error("Must supply a serverProtocol, e.g. http:"); } if (!serverHostName) { throw new Error("Must supply serverHostName, e.g. 192.168.1.1 or myServerName"); } if (!serverPortNumber) { throw new Error("Must supply a serverPortNumber"); } var self = this; var deviceName = "Web Browser"; var deviceId = MediaBrowser.SHA1(navigator.userAgent + (navigator.cpuClass || "")); var currentUserId; var webSocket; /** * Gets the server host name. */ self.serverHostName = function () { return serverHostName; }; /** * Gets the server port number. */ self.serverPortNumber = function () { return serverPortNumber; }; /** * Gets or sets the current user id. */ self.currentUserId = function (val) { if (val !== undefined) { currentUserId = val; } else { return currentUserId; } }; deviceName = (function () { var name = ""; if ($.browser.chrome) { name = "Chrome"; } else if ($.browser.safari) { name = "Safari"; } else if ($.browser.webkit) { name = "WebKit"; } else if ($.browser.msie) { name = "Internet Explorer"; } else if ($.browser.firefox || $.browser.mozilla) { name = "Firefox"; } else if ($.browser.opera) { name = "Opera"; } else { name = "Web Browser"; } if ($.browser.ipad) { name += " Ipad"; } else if ($.browser.iphone) { name += " Iphone"; } else if ($.browser.android) { name += " Android"; } return name; }()); self.deviceId = function () { return deviceId; }; self.encodeName = function (name) { name = name.split('/').join('-'); name = name.split('?').join('-'); var val = $.param({ name: name }); return val.substring(val.indexOf('=') + 1).replace("'", '%27'); }; /** * Wraps around jQuery ajax methods to add additional info to the request. */ self.ajax = function (request) { if (!request) { throw new Error("Request cannot be null"); } if (clientName) { var auth = 'MediaBrowser Client="' + clientName + '", Device="' + deviceName + '", DeviceId="' + deviceId + '"'; if (currentUserId) { auth += ', UserId="' + currentUserId + '"'; } request.headers = { Authorization: auth }; } return $.ajax(request); }; /** * Creates an api url based on a handler name and query string parameters * @param {String} name * @param {Object} params */ self.getUrl = function (name, params) { if (!name) { throw new Error("Url name cannot be empty"); } var url = serverProtocol + "//" + serverHostName + ":" + serverPortNumber + "/mediabrowser/" + name; if (params) { url += "?" + $.param(params); } return url; }; self.openWebSocket = function (port) { var url = "ws://" + serverHostName + ":" + port + "/mediabrowser"; webSocket = new WebSocket(url); webSocket.onmessage = function (msg) { msg = JSON.parse(msg.data); $(self).trigger("websocketmessage", [msg]); }; webSocket.onopen = function () { setTimeout(function () { self.sendWebSocketMessage("Identity", clientName + "|" + deviceId); $(self).trigger("websocketopen"); }, 500); }; webSocket.onerror = function () { setTimeout(function () { $(self).trigger("websocketerror"); }, 0); }; webSocket.onclose = function () { setTimeout(function () { $(self).trigger("websocketclose"); }, 0); }; }; self.sendWebSocketMessage = function (name, data) { var msg = { MessageType: name }; if (data) { msg.Data = data; } msg = JSON.stringify(msg); webSocket.send(msg); }; self.isWebSocketOpen = function () { return webSocket && webSocket.readyState === WebSocket.OPEN; }; self.isWebSocketOpenOrConnecting = function () { return webSocket && (webSocket.readyState === WebSocket.OPEN || webSocket.readyState === WebSocket.CONNECTING); }; /** * Gets an item from the server * Omit itemId to get the root folder. */ self.getItem = function (userId, itemId) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/Items/" + itemId); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the root folder from the server */ self.getRootFolder = function (userId) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/Items/Root"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the current server status */ self.getSystemInfo = function () { var url = self.getUrl("System/Info"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getSimilarItems = function (itemId, options) { var url = self.getUrl("Items/" + itemId + "/Similar", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets all cultures known to the server */ self.getCultures = function () { var url = self.getUrl("Localization/cultures"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets all countries known to the server */ self.getCountries = function () { var url = self.getUrl("Localization/countries"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets plugin security info */ self.getPluginSecurityInfo = function () { var url = self.getUrl("Plugins/SecurityInfo"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the directory contents of a path on the server */ self.getDirectoryContents = function (path, options) { if (!path) { throw new Error("null path"); } options = options || {}; options.path = path; var url = self.getUrl("Environment/DirectoryContents", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a list of physical drives from the server */ self.getDrives = function () { var url = self.getUrl("Environment/Drives"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a list of network devices from the server */ self.getNetworkDevices = function () { var url = self.getUrl("Environment/NetworkDevices"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Cancels a package installation */ self.cancelPackageInstallation = function (installationId) { if (!installationId) { throw new Error("null installationId"); } var url = self.getUrl("Packages/Installing/" + id); return self.ajax({ type: "DELETE", url: url }); }; /** * Refreshes metadata for an item */ self.refreshItem = function (itemId, force, recursive) { if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Items/" + itemId + "/Refresh", { force: force || false, recursive: recursive || false }); return self.ajax({ type: "POST", url: url }); }; /** * Installs or updates a new plugin */ self.installPlugin = function (name, updateClass, version) { if (!name) { throw new Error("null name"); } if (!updateClass) { throw new Error("null updateClass"); } var options = { updateClass: updateClass }; if (version) { options.version = version; } var url = self.getUrl("Packages/Installed/" + name, options); return self.ajax({ type: "POST", url: url }); }; /** * Instructs the server to perform a pending kernel reload or app restart. * If a restart is not currently required, nothing will happen. */ self.performPendingRestart = function () { var url = self.getUrl("System/Restart"); return self.ajax({ type: "POST", url: url }); }; /** * Gets information about an installable package */ self.getPackageInfo = function (name) { if (!name) { throw new Error("null name"); } var url = self.getUrl("Packages/" + name); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the latest available application update (if any) */ self.getAvailableApplicationUpdate = function () { var url = self.getUrl("Packages/Updates", { PackageType: "System" }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the latest available plugin updates (if any) */ self.getAvailablePluginUpdates = function () { var url = self.getUrl("Packages/Updates", { PackageType: "UserInstalled" }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the virtual folder for a view. Specify a userId to get a user view, or omit for the default view. */ self.getVirtualFolders = function (userId) { var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url = self.getUrl(url); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets all the paths of the locations in the physical root. */ self.getPhysicalPaths = function () { var url = self.getUrl("Library/PhysicalPaths"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the current server configuration */ self.getServerConfiguration = function () { var url = self.getUrl("System/Configuration"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets the server's scheduled tasks */ self.getScheduledTasks = function () { var url = self.getUrl("ScheduledTasks"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Starts a scheduled task */ self.startScheduledTask = function (id) { if (!id) { throw new Error("null id"); } var url = self.getUrl("ScheduledTasks/Running/" + id); return self.ajax({ type: "POST", url: url }); }; /** * Gets a scheduled task */ self.getScheduledTask = function (id) { if (!id) { throw new Error("null id"); } var url = self.getUrl("ScheduledTasks/" + id); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getNextUpEpisodes = function (options) { var url = self.getUrl("Shows/NextUp", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Stops a scheduled task */ self.stopScheduledTask = function (id) { if (!id) { throw new Error("null id"); } var url = self.getUrl("ScheduledTasks/Running/" + id); return self.ajax({ type: "DELETE", url: url }); }; /** * Gets the configuration of a plugin * @param {String} Id */ self.getPluginConfiguration = function (id) { if (!id) { throw new Error("null Id"); } var url = self.getUrl("Plugins/" + id + "/Configuration"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a list of plugins that are available to be installed */ self.getAvailablePlugins = function (options) { options = $.extend({}, options || {}); options.PackageType = "UserInstalled"; var url = self.getUrl("Packages", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Uninstalls a plugin * @param {String} Id */ self.uninstallPlugin = function (id) { if (!id) { throw new Error("null Id"); } var url = self.getUrl("Plugins/" + id); return self.ajax({ type: "DELETE", url: url }); }; /** * Removes a virtual folder from either the default view or a user view * @param {String} name */ self.removeVirtualFolder = function (name, userId) { if (!name) { throw new Error("null name"); } var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url += "/" + name; url = self.getUrl(url); return self.ajax({ type: "DELETE", url: url }); }; /** * Adds a virtual folder to either the default view or a user view * @param {String} name */ self.addVirtualFolder = function (name, userId) { if (!name) { throw new Error("null name"); } var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url += "/" + name; url = self.getUrl(url); return self.ajax({ type: "POST", url: url }); }; /** * Renames a virtual folder, within either the default view or a user view * @param {String} name */ self.renameVirtualFolder = function (name, newName, userId) { if (!name) { throw new Error("null name"); } var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url += "/" + name + "/Name"; url = self.getUrl(url, { newName: newName }); return self.ajax({ type: "POST", url: url }); }; /** * Adds an additional mediaPath to an existing virtual folder, within either the default view or a user view * @param {String} name */ self.addMediaPath = function (virtualFolderName, mediaPath, userId) { if (!virtualFolderName) { throw new Error("null virtualFolderName"); } if (!mediaPath) { throw new Error("null mediaPath"); } var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url += "/" + virtualFolderName + "/Paths"; url = self.getUrl(url, { path: mediaPath }); return self.ajax({ type: "POST", url: url }); }; /** * Removes a media path from a virtual folder, within either the default view or a user view * @param {String} name */ self.removeMediaPath = function (virtualFolderName, mediaPath, userId) { if (!virtualFolderName) { throw new Error("null virtualFolderName"); } if (!mediaPath) { throw new Error("null mediaPath"); } var url = userId ? "Users/" + userId + "/VirtualFolders" : "Library/VirtualFolders"; url += "/" + virtualFolderName + "/Paths"; url = self.getUrl(url, { path: mediaPath }); return self.ajax({ type: "DELETE", url: url }); }; /** * Deletes a user * @param {String} id */ self.deleteUser = function (id) { if (!id) { throw new Error("null id"); } var url = self.getUrl("Users/" + id); return self.ajax({ type: "DELETE", url: url }); }; /** * Deletes a user image * @param {String} userId * @param {String} imageType The type of image to delete, based on the server-side ImageType enum. */ self.deleteUserImage = function (userId, imageType, imageIndex) { if (!userId) { throw new Error("null userId"); } if (!imageType) { throw new Error("null imageType"); } var url = self.getUrl("Users/" + userId + "/Images/" + imageType); if (imageIndex != null) { url += "/" + imageIndex; } return self.ajax({ type: "DELETE", url: url }); }; self.deleteItemImage = function (itemId, imageType, imageIndex) { if (!itemId) { throw new Error("null itemId"); } if (!imageType) { throw new Error("null imageType"); } var url = self.getUrl("Items/" + itemId + "/Images/" + imageType); if (imageIndex != null) { url += "/" + imageIndex; } return self.ajax({ type: "DELETE", url: url }); }; self.updateItemImageIndex = function (itemId, imageType, imageIndex, newIndex) { if (!itemId) { throw new Error("null itemId"); } if (!imageType) { throw new Error("null imageType"); } var url = self.getUrl("Items/" + itemId + "/Images/" + imageType + "/" + imageIndex + "/Index", { newIndex: newIndex }); return self.ajax({ type: "POST", url: url }); }; self.getItemImageInfos = function (itemId) { if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Items/" + itemId + "/Images"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getCriticReviews = function (itemId, options) { if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Items/" + itemId + "/CriticReviews", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getSessions = function (options) { var url = self.getUrl("Sessions", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Uploads a user image * @param {String} userId * @param {String} imageType The type of image to delete, based on the server-side ImageType enum. * @param {Object} file The file from the input element */ self.uploadUserImage = function (userId, imageType, file) { if (!userId) { throw new Error("null userId"); } if (!imageType) { throw new Error("null imageType"); } if (!file) { throw new Error("File must be an image."); } if (file.type != "image/png" && file.type != "image/jpeg" && file.type != "image/jpeg") { throw new Error("File must be an image."); } var deferred = $.Deferred(); var reader = new FileReader(); reader.onerror = function () { deferred.reject(); }; reader.onabort = function () { deferred.reject(); }; // Closure to capture the file information. reader.onload = function (e) { // Split by a comma to remove the url: prefix var data = e.target.result.split(',')[1]; var url = self.getUrl("Users/" + userId + "/Images/" + imageType); self.ajax({ type: "POST", url: url, data: data, contentType: "image/" + file.name.substring(file.name.lastIndexOf('.') + 1) }).done(function (result) { deferred.resolveWith(null, [result]); }).fail(function () { deferred.reject(); }); }; // Read in the image file as a data URL. reader.readAsDataURL(file); return deferred.promise(); }; self.uploadItemImage = function (itemId, imageType, file) { if (!itemId) { throw new Error("null itemId"); } if (!imageType) { throw new Error("null imageType"); } if (!file) { throw new Error("File must be an image."); } if (file.type != "image/png" && file.type != "image/jpeg" && file.type != "image/jpeg") { throw new Error("File must be an image."); } var deferred = $.Deferred(); var reader = new FileReader(); reader.onerror = function () { deferred.reject(); }; reader.onabort = function () { deferred.reject(); }; // Closure to capture the file information. reader.onload = function (e) { // Split by a comma to remove the url: prefix var data = e.target.result.split(',')[1]; var url = self.getUrl("Items/" + itemId + "/Images/" + imageType); self.ajax({ type: "POST", url: url, data: data, contentType: "image/" + file.name.substring(file.name.lastIndexOf('.') + 1) }).done(function (result) { deferred.resolveWith(null, [result]); }).fail(function () { deferred.reject(); }); }; // Read in the image file as a data URL. reader.readAsDataURL(file); return deferred.promise(); }; /** * Gets the list of installed plugins on the server */ self.getInstalledPlugins = function () { var url = self.getUrl("Plugins"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a user by id * @param {String} id */ self.getUser = function (id) { if (!id) { throw new Error("Must supply a userId"); } var url = self.getUrl("Users/" + id); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a studio */ self.getStudio = function (name, userId) { if (!name) { throw new Error("null name"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Studios/" + self.encodeName(name), options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a genre */ self.getGenre = function (name, userId) { if (!name) { throw new Error("null name"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Genres/" + self.encodeName(name), options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets an artist */ self.getArtist = function (name, userId) { if (!name) { throw new Error("null name"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Artists/" + self.encodeName(name), options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a year */ self.getYear = function (yea, userId) { if (!name) { throw new Error("null name"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Years/" + self.encodeName(name), options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a Person */ self.getPerson = function (name, userId) { if (!name) { throw new Error("null name"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Persons/" + self.encodeName(name), options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets weather info * @param {String} location - us zip code / city, state, country / city, country * Omit location to get weather info using stored server configuration value */ self.getWeatherInfo = function (location) { var url = self.getUrl("weather", { location: location }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets all users from the server */ self.getUsers = function () { var url = self.getUrl("users"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets all available parental ratings from the server */ self.getParentalRatings = function () { var url = self.getUrl("Localization/ParentalRatings"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets a list of all available conrete BaseItem types from the server */ self.getItemTypes = function (options) { var url = self.getUrl("Library/ItemTypes", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Constructs a url for a user image * @param {String} userId * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getUserImageUrl = function (userId, options) { if (!userId) { throw new Error("null userId"); } options = options || { }; var url = "Users/" + userId + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for a person image * @param {String} name * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getPersonImageUrl = function (name, options) { if (!name) { throw new Error("null name"); } options = options || { }; var url = "Persons/" + self.encodeName(name) + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for a year image * @param {String} year * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getYearImageUrl = function (year, options) { if (!year) { throw new Error("null year"); } options = options || { }; var url = "Years/" + year + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for a genre image * @param {String} name * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getGenreImageUrl = function (name, options) { if (!name) { throw new Error("null name"); } options = options || { }; var url = "Genres/" + self.encodeName(name) + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for a artist image * @param {String} name * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getArtistImageUrl = function (name, options) { if (!name) { throw new Error("null name"); } options = options || { }; var url = "Artists/" + self.encodeName(name) + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for a studio image * @param {String} name * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getStudioImageUrl = function (name, options) { if (!name) { throw new Error("null name"); } options = options || { }; var url = "Studios/" + self.encodeName(name) + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for an item image * @param {String} itemId * @param {Object} options * Options supports the following properties: * type - Primary, logo, backdrop, etc. See the server-side enum ImageType * index - When downloading a backdrop, use this to specify which one (omitting is equivalent to zero) * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getImageUrl = function (itemId, options) { if (!itemId) { throw new Error("itemId cannot be empty"); } options = options || { }; var url = "Items/" + itemId + "/Images/" + options.type; if (options.index != null) { url += "/" + options.index; } // Don't put these on the query string delete options.type; delete options.index; return self.getUrl(url, options); }; /** * Constructs a url for an item logo image * If the item doesn't have a logo, it will inherit a logo from a parent * @param {Object} item A BaseItem * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getLogoImageUrl = function (item, options) { if (!item) { throw new Error("null item"); } options = options || { }; options.imageType = "logo"; var logoItemId = item.HasLogo ? item.Id : item.ParentLogoItemId; return logoItemId ? self.getImageUrl(logoItemId, options) : null; }; /** * Constructs an array of backdrop image url's for an item * If the item doesn't have any backdrops, it will inherit them from a parent * @param {Object} item A BaseItem * @param {Object} options * Options supports the following properties: * width - download the image at a fixed width * height - download the image at a fixed height * maxWidth - download the image at a maxWidth * maxHeight - download the image at a maxHeight * quality - A scale of 0-100. This should almost always be omitted as the default will suffice. * For best results do not specify both width and height together, as aspect ratio might be altered. */ self.getBackdropImageUrl = function (item, options) { if (!item) { throw new Error("null item"); } options = options || { }; options.imageType = "backdrop"; var backdropItemId; var backdropCount; if (!item.BackdropCount) { backdropItemId = item.ParentBackdropItemId; backdropCount = item.ParentBackdropCount || 0; } else { backdropItemId = item.Id; backdropCount = item.BackdropCount; } if (!backdropItemId) { return []; } var files = []; for (var i = 0; i < backdropCount; i++) { options.imageIndex = i; files[i] = self.getImageUrl(backdropItemId, options); } return files; }; /** * Authenticates a user * @param {String} userId * @param {String} password */ self.authenticateUser = function (userId, password) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/authenticate"); var postData = { password: MediaBrowser.SHA1(password || "") }; return self.ajax({ type: "POST", url: url, data: JSON.stringify(postData), contentType: "application/json" }); }; /** * Updates a user's password * @param {String} userId * @param {String} currentPassword * @param {String} newPassword */ self.updateUserPassword = function (userId, currentPassword, newPassword) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/Password"); var postData = { }; postData.currentPassword = MediaBrowser.SHA1(currentPassword); if (newPassword) { postData.newPassword = newPassword; } return self.ajax({ type: "POST", url: url, data: postData }); }; /** * Resets a user's password * @param {String} userId */ self.resetUserPassword = function (userId) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/Password"); var postData = { }; postData.resetPassword = true; return self.ajax({ type: "POST", url: url, data: postData }); }; /** * Updates the server's configuration * @param {Object} configuration */ self.updateServerConfiguration = function (configuration) { if (!configuration) { throw new Error("null configuration"); } var url = self.getUrl("System/Configuration"); return self.ajax({ type: "POST", url: url, data: JSON.stringify(configuration), contentType: "application/json" }); }; /** * Updates plugin security info */ self.updatePluginSecurityInfo = function (info) { var url = self.getUrl("Plugins/SecurityInfo"); return self.ajax({ type: "POST", url: url, data: JSON.stringify(info), contentType: "application/json" }); }; /** * Creates a user * @param {Object} user */ self.createUser = function (user) { if (!user) { throw new Error("null user"); } var url = self.getUrl("Users"); return self.ajax({ type: "POST", url: url, data: JSON.stringify(user), dataType: "json", contentType: "application/json" }); }; /** * Updates a user * @param {Object} user */ self.updateUser = function (user) { if (!user) { throw new Error("null user"); } var url = self.getUrl("Users/" + user.Id); return self.ajax({ type: "POST", url: url, data: JSON.stringify(user), contentType: "application/json" }); }; /** * Updates the Triggers for a ScheduledTask * @param {String} id * @param {Object} triggers */ self.updateScheduledTaskTriggers = function (id, triggers) { if (!id) { throw new Error("null id"); } if (!triggers) { throw new Error("null triggers"); } var url = self.getUrl("ScheduledTasks/" + id + "/Triggers"); return self.ajax({ type: "POST", url: url, data: JSON.stringify(triggers), contentType: "application/json" }); }; /** * Updates a plugin's configuration * @param {String} Id * @param {Object} configuration */ self.updatePluginConfiguration = function (id, configuration) { if (!id) { throw new Error("null Id"); } if (!configuration) { throw new Error("null configuration"); } var url = self.getUrl("Plugins/" + id + "/Configuration"); return self.ajax({ type: "POST", url: url, data: JSON.stringify(configuration), contentType: "application/json" }); }; /** * Gets items based on a query, typically for children of a folder * @param {String} userId * @param {Object} options * Options accepts the following properties: * itemId - Localize the search to a specific folder (root if omitted) * startIndex - Use for paging * limit - Use to limit results to a certain number of items * filter - Specify one or more ItemFilters, comma delimeted (see server-side enum) * sortBy - Specify an ItemSortBy (comma-delimeted list see server-side enum) * sortOrder - ascending/descending * fields - additional fields to include aside from basic info. This is a comma delimited list. See server-side enum ItemFields. * index - the name of the dynamic, localized index function * dynamicSortBy - the name of the dynamic localized sort function * recursive - Whether or not the query should be recursive * searchTerm - search term to use as a filter */ self.getItems = function (userId, options) { if (!userId) { throw new Error("null userId"); } var url = self.getUrl("Users/" + userId + "/Items", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets artists from an item */ self.getArtists = function (userId, options) { if (!userId) { throw new Error("null userId"); } options = options || {}; options.userId = userId; var url = self.getUrl("Artists", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets genres from an item */ self.getGenres = function (userId, options) { if (!userId) { throw new Error("null userId"); } options = options || {}; options.userId = userId; var url = self.getUrl("Genres", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets people from an item */ self.getPeople = function (userId, options) { if (!userId) { throw new Error("null userId"); } options = options || {}; options.userId = userId; var url = self.getUrl("Persons", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets studios from an item */ self.getStudios = function (userId, options) { if (!userId) { throw new Error("null userId"); } options = options || {}; options.userId = userId; var url = self.getUrl("Studios", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets local trailers for an item */ self.getLocalTrailers = function (userId, itemId) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/Items/" + itemId + "/LocalTrailers"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets theme songs for an item */ self.getThemeSongs = function (userId, itemId) { if (!itemId) { throw new Error("null itemId"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Items/" + itemId + "/ThemeSongs", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getThemeVideos = function (userId, itemId) { if (!itemId) { throw new Error("null itemId"); } var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Items/" + itemId + "/ThemeVideos", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; self.getSearchHints = function (options) { var url = self.getUrl("Search/Hints", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Gets special features for an item */ self.getSpecialFeatures = function (userId, itemId) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/Items/" + itemId + "/SpecialFeatures"); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Marks an item as played or unplayed * This should not be used to update playstate following playback. * There are separate playstate check-in methods for that. This should be used for a * separate option to reset playstate. * @param {String} userId * @param {String} itemId * @param {Boolean} wasPlayed */ self.updatePlayedStatus = function (userId, itemId, wasPlayed) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/PlayedItems/" + itemId); var method = wasPlayed ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; /** * Updates a user's favorite status for an item. * @param {String} userId * @param {String} itemId * @param {Boolean} isFavorite */ self.updateFavoriteStatus = function (userId, itemId, isFavorite) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/FavoriteItems/" + itemId); var method = isFavorite ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; /** * Updates a user's personal rating for an item * @param {String} userId * @param {String} itemId * @param {Boolean} likes */ self.updateUserItemRating = function (userId, itemId, likes) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/Items/" + itemId + "/Rating", { likes: likes }); return self.ajax({ type: "POST", url: url }); }; /** * Updates a user's favorite status for an item by name. * @param {String} userId * @param {String} name * @param {Boolean} isFavorite */ self.updateFavoriteArtistStatus = function (userId, name, isFavorite) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Favorites/Artists/" + self.encodeName(name)); var method = isFavorite ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; self.updateFavoritePersonStatus = function (userId, name, isFavorite) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Favorites/Persons/" + self.encodeName(name)); var method = isFavorite ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; self.updateFavoriteStudioStatus = function (userId, name, isFavorite) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Favorites/Studios/" + self.encodeName(name)); var method = isFavorite ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; self.updateFavoriteGenreStatus = function (userId, name, isFavorite) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Favorites/Genres/" + self.encodeName(name)); var method = isFavorite ? "POST" : "DELETE"; return self.ajax({ type: method, url: url }); }; /** * Updates a user's rating for an item by name. * @param {String} userId * @param {String} name * @param {Boolean} likes */ self.updateArtistRating = function (userId, name, likes) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Artists/" + self.encodeName(name), { likes: likes }); return self.ajax({ type: "POST", url: url }); }; self.updatePersonRating = function (userId, name, likes) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Persons/" + self.encodeName(name), { likes: likes }); return self.ajax({ type: "POST", url: url }); }; self.updateStudioRating = function (userId, name, likes) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Studios/" + self.encodeName(name), { likes: likes }); return self.ajax({ type: "POST", url: url }); }; self.updateGenreRating = function (userId, name, likes) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Genres/" + self.encodeName(name), { likes: likes }); return self.ajax({ type: "POST", url: url }); }; /** * Clears a user's rating for an item by name. * @param {String} userId * @param {String} name */ self.clearArtistRating = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Artists/" + self.encodeName(name)); return self.ajax({ type: "DELETE", url: url }); }; self.clearPersonRating = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Persons/" + self.encodeName(name)); return self.ajax({ type: "DELETE", url: url }); }; self.clearStudioRating = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Studios/" + self.encodeName(name)); return self.ajax({ type: "DELETE", url: url }); }; self.clearGenreRating = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Users/" + userId + "/Ratings/Genres/" + self.encodeName(name)); return self.ajax({ type: "DELETE", url: url }); }; self.getItemCounts = function (userId) { var options = {}; if (userId) { options.userId = userId; } var url = self.getUrl("Items/Counts", options); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets a variety of item counts that a person appears in */ self.getPersonItemCounts = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Persons/" + self.encodeName(name) + "/Counts", { userId: userId }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets a variety of item counts that a genre appears in */ self.getGenreItemCounts = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Genres/" + self.encodeName(name) + "/Counts", { userId: userId }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets a variety of item counts that an artist appears in */ self.getArtistItemCounts = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Artists/" + self.encodeName(name) + "/Counts", { userId: userId }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** Gets a variety of item counts that a studio appears in */ self.getStudioItemCounts = function (userId, name) { if (!userId) { throw new Error("null userId"); } if (!name) { throw new Error("null name"); } var url = self.getUrl("Studios/" + self.encodeName(name) + "/Counts", { userId: userId }); return self.ajax({ type: "GET", url: url, dataType: "json" }); }; /** * Clears a user's personal rating for an item * @param {String} userId * @param {String} itemId */ self.clearUserItemRating = function (userId, itemId) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } var url = self.getUrl("Users/" + userId + "/Items/" + itemId + "/Rating"); return self.ajax({ type: "DELETE", url: url }); }; /** * Reports the user has started playing something * @param {String} userId * @param {String} itemId */ self.reportPlaybackStart = function (userId, itemId) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } if (self.isWebSocketOpen()) { var deferred = $.Deferred(); self.sendWebSocketMessage("PlaybackStart", itemId); deferred.resolveWith(null, []); return deferred.promise(); } var url = self.getUrl("Users/" + userId + "/PlayingItems/" + itemId); return self.ajax({ type: "POST", url: url }); }; /** * Reports progress viewing an item * @param {String} userId * @param {String} itemId */ self.reportPlaybackProgress = function (userId, itemId, positionTicks, isPaused) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } if (self.isWebSocketOpen()) { var deferred = $.Deferred(); self.sendWebSocketMessage("PlaybackProgress", itemId + "|" + (positionTicks == null ? "" : positionTicks) + "|" + (isPaused == null ? "" : isPaused)); deferred.resolveWith(null, []); return deferred.promise(); } var params = { }; if (positionTicks) { params.positionTicks = positionTicks; } var url = self.getUrl("Users/" + userId + "/PlayingItems/" + itemId + "/Progress", params); return self.ajax({ type: "POST", url: url }); }; /** * Reports a user has stopped playing an item * @param {String} userId * @param {String} itemId */ self.reportPlaybackStopped = function (userId, itemId, positionTicks) { if (!userId) { throw new Error("null userId"); } if (!itemId) { throw new Error("null itemId"); } if (self.isWebSocketOpen()) { var deferred = $.Deferred(); self.sendWebSocketMessage("PlaybackStopped", itemId + "|" + (positionTicks == null ? "" : positionTicks)); deferred.resolveWith(null, []); return deferred.promise(); } var params = { }; if (positionTicks) { params.positionTicks = positionTicks; } var url = self.getUrl("Users/" + userId + "/PlayingItems/" + itemId, params); return self.ajax({ type: "DELETE", url: url }); }; } }(jQuery, navigator, window.JSON, window.WebSocket, setTimeout); /** * Provides a friendly way to create an api client instance using information from the browser's current url */ MediaBrowser.ApiClient.create = function (clientName) { var loc = window.location; return new MediaBrowser.ApiClient(loc.protocol, loc.hostname, loc.port, clientName); }; /** * * Secure Hash Algorithm (SHA1) * http://www.webtoolkit.info/ * **/ MediaBrowser.SHA1 = function (msg) { function rotate_left(n, s) { var t4 = (n << s) | (n >>> (32 - s)); return t4; } function lsb_hex(val) { var str = ""; var i; var vh; var vl; for (i = 0; i <= 6; i += 2) { vh = (val >>> (i * 4 + 4)) & 0x0f; vl = (val >>> (i * 4)) & 0x0f; str += vh.toString(16) + vl.toString(16); } return str; } function cvt_hex(val) { var str = ""; var i; var v; for (i = 7; i >= 0; i--) { v = (val >>> (i * 4)) & 0x0f; str += v.toString(16); } return str; } function Utf8Encode(string) { string = string.replace(/\r\n/g, "\n"); var utftext = ""; for (var n = 0; n < string.length; n++) { var c = string.charCodeAt(n); if (c < 128) { utftext += String.fromCharCode(c); } else if ((c > 127) && (c < 2048)) { utftext += String.fromCharCode((c >> 6) | 192); utftext += String.fromCharCode((c & 63) | 128); } else { utftext += String.fromCharCode((c >> 12) | 224); utftext += String.fromCharCode(((c >> 6) & 63) | 128); utftext += String.fromCharCode((c & 63) | 128); } } return utftext; } var blockstart; var i, j; var W = new Array(80); var H0 = 0x67452301; var H1 = 0xEFCDAB89; var H2 = 0x98BADCFE; var H3 = 0x10325476; var H4 = 0xC3D2E1F0; var A, B, C, D, E; var temp; msg = Utf8Encode(msg); var msg_len = msg.length; var word_array = new Array(); for (i = 0; i < msg_len - 3; i += 4) { j = msg.charCodeAt(i) << 24 | msg.charCodeAt(i + 1) << 16 | msg.charCodeAt(i + 2) << 8 | msg.charCodeAt(i + 3); word_array.push(j); } switch (msg_len % 4) { case 0: i = 0x080000000; break; case 1: i = msg.charCodeAt(msg_len - 1) << 24 | 0x0800000; break; case 2: i = msg.charCodeAt(msg_len - 2) << 24 | msg.charCodeAt(msg_len - 1) << 16 | 0x08000; break; case 3: i = msg.charCodeAt(msg_len - 3) << 24 | msg.charCodeAt(msg_len - 2) << 16 | msg.charCodeAt(msg_len - 1) << 8 | 0x80; break; } word_array.push(i); while ((word_array.length % 16) != 14) word_array.push(0); word_array.push(msg_len >>> 29); word_array.push((msg_len << 3) & 0x0ffffffff); for (blockstart = 0; blockstart < word_array.length; blockstart += 16) { for (i = 0; i < 16; i++) W[i] = word_array[blockstart + i]; for (i = 16; i <= 79; i++) W[i] = rotate_left(W[i - 3] ^ W[i - 8] ^ W[i - 14] ^ W[i - 16], 1); A = H0; B = H1; C = H2; D = H3; E = H4; for (i = 0; i <= 19; i++) { temp = (rotate_left(A, 5) + ((B & C) | (~B & D)) + E + W[i] + 0x5A827999) & 0x0ffffffff; E = D; D = C; C = rotate_left(B, 30); B = A; A = temp; } for (i = 20; i <= 39; i++) { temp = (rotate_left(A, 5) + (B ^ C ^ D) + E + W[i] + 0x6ED9EBA1) & 0x0ffffffff; E = D; D = C; C = rotate_left(B, 30); B = A; A = temp; } for (i = 40; i <= 59; i++) { temp = (rotate_left(A, 5) + ((B & C) | (B & D) | (C & D)) + E + W[i] + 0x8F1BBCDC) & 0x0ffffffff; E = D; D = C; C = rotate_left(B, 30); B = A; A = temp; } for (i = 60; i <= 79; i++) { temp = (rotate_left(A, 5) + (B ^ C ^ D) + E + W[i] + 0xCA62C1D6) & 0x0ffffffff; E = D; D = C; C = rotate_left(B, 30); B = A; A = temp; } H0 = (H0 + A) & 0x0ffffffff; H1 = (H1 + B) & 0x0ffffffff; H2 = (H2 + C) & 0x0ffffffff; H3 = (H3 + D) & 0x0ffffffff; H4 = (H4 + E) & 0x0ffffffff; } var temp = cvt_hex(H0) + cvt_hex(H1) + cvt_hex(H2) + cvt_hex(H3) + cvt_hex(H4); return temp.toLowerCase(); }; (function (jQuery, window, undefined) { "use strict"; var matched, browser; jQuery.uaMatch = function (ua) { ua = ua.toLowerCase(); var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || /(webkit)[ \/]([\w.]+)/.exec(ua) || /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || /(msie) ([\w.]+)/.exec(ua) || ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || []; var platform_match = /(ipad)/.exec(ua) || /(iphone)/.exec(ua) || /(android)/.exec(ua) || []; return { browser: match[1] || "", version: match[2] || "0", platform: platform_match[0] || "" }; }; matched = jQuery.uaMatch(window.navigator.userAgent); browser = {}; if (matched.browser) { browser[matched.browser] = true; browser.version = matched.version; } if (matched.platform) { browser[matched.platform] = true } // Chrome is Webkit, but Webkit is also Safari. if (browser.chrome) { browser.webkit = true; } else if (browser.webkit) { browser.safari = true; } jQuery.browser = browser; })(jQuery, window);