Sage TV Web Interface
These pages describe the plugin for SageTV that provide a web-interface to Sage TV allowing you to control Sage from any web-browser.
Features
- Sage Recordings list with sorting/grouping
- EPG views with adjustable sizing
- Recording Schedule
- Conflict Management
- Intelligent Suggestions -- see what Sage thinks you might like, with custom grouping/sorting, without needing Intelligent Recording to be enabled
- Search of program guide, media library, Sage recordings, Viewing history with advanced filtering/sorting options
- Favorites management
- System Messages
- Simple web-based media player for use in a LAN.
- Web-remote -- control Sage from your PDA
- Viewing History mangement -- clear watched flags on viewed programs
XML output of show information for use by other programs
- Sage Playlist export
RSS feeds for Recording Schedule, Recording Conflicts, and Intelligent Suggestions
- XML show information export and import
Instructions
Version History
New versions can be monitored using SourceForges' RSS feed for new releases
----
ENHANCEMENTS
- (slugger, stuckless, jreichen) Run as an application on the Jetty web server plugin (deploy as a .war file)
- (jreichen) System Messages page and RSS feed (requires SageTV 6.5.17 or later)
----
BUGFIXES:
- zipfile contains HTML pages this time
ENHANCEMENTS
- ToonGal's updated icons for the web-remote
----
- Requires Java JRE v1.6
BUGFIXES:
- Import allows multiple airings for null channels
- (jreichen) Set search string text box as the control with default focus on search page
- (jreichen) The episode id is always the last 4 digits of the show id, regardless of the length of the show id
- (jreichen) Fix errors that prevented VLC streaming from a Linux server.
- (jreichen) Add server-side buffering for VLC streaming to reduce premature end-of-file errors
- (jreichen) Recordings were not scheduled for a new favorite with a selected channel
- (jreichen) Favorite Options item was sometimes still displayed on details page after favorite was deleted
- (jreichen) Conflicts page crashes if missed airing is a manual recording
- (jreichen) Conflict icon for missed manual recording not displayed in EPG, details, or search results
- (jreichen) Web server was assuming port 80 was the default port when generating HTTP and HTTPS URLs. It should be port 80 for HTTP and port 443 for HTTPS
- (jreichen) RSS feed items had a problem in the URL and viewing them would display an error that it was an unknown AiringId?
- (jreichen) Remove unnecessary parameters from RSS feed URL because of the limit on the URL length in iTunes subscriptions
- (jreichen) In the EPG Channel View, handle the case where no channels are configured in SageTV or the URL has invalid channel IDs
ENHANCEMENTS
- (jreichen) Custom CSS styles for show categories and subcategories
- (jreichen) Support for multi-channel favorites
BUGFIXES:
- MVP / HD Extender power off should now work!
----
V2.21 10 Dec 2007 For SageTV 2.2-6.3 BUGFIXES:
- Fix ReturnTo? search results when deleting from detailed info
- RSS feeds can contain media files with size > 2Gb (although the feedreader may have problems due to int overflow)
ENHANCEMENTS
- Generate default filename for exported XML from detailed info
- Import function can now be used to fix file timestamps (eg after editing)
- Imported XML data no longer needs to have start time/duration (can be inferred from file)
- RSS feeds from search results now are automatically named (A custom name possible with the '&title=My%20Custom%20Name' argument)
- Ability to poweroff and reboot the STX-HD100 extender (untested!)
- Updated XML import/export to 1.3 DTD -- Airing/Mediafile durations no longer required
- fixed channel problem in Favourites manager
BUGFIXES:
- Fixed failure to start with corrupt throttles file
- Use playlist name as filename when exporting playlist
- Include Media File URL as Enclosure in RSS feeds (enables podcasting)
- Fix video conversion auto file-naming (was always using old filename+ext)
BUGFIXES:
- Video conversions: remember last format name/quality and display full format name
- Video conversions: fix page title
- Video conversions: Show status of replace original and view converted file info
- XML export: use different DTD URL
- Playlist export: indicate number/type of pl segments
- renamed conflictIcon.gif
BUGFIXES:
- Video conversions: clean up deleted files before display (fixes java error when src file was deleted)
- Detailed Info do not attempt to display 'convert' menu item if < v5.1 (fixes java error in 5.0)
- fix MVP power off command 404
- fix MVP power off command on linux
---- v2.17 08 Aug 2007
BUGFIXES:
- Picture Detailed Info: restore pre V6 compatability
- Edit Show info: Restore pre SageTV v5.0 compatability (another attempt)
- remove width: auto CSS (triggers Firefox rendering bug)
- make detailed info work with JRE 1.4 again
- make 'all' items per page work.
- fix XML importing where showID, AiringID is blank
ENHANCEMENTS
- use mayamaniac's improved tileable bkg image
- add css file for 'handheld' mediatype (default file just disables bkg image for the moment: enhancements welcome!)
- add experimental support for custom css ('theming')
- to set, at the Home page, enter in address bar: javascript:SetCookie("custom_css","my_custom.css")
- to clear, at the Home page, enter in address bar: javascript:DeleteOptionsCookie("custom_css")
- file must exist in webserver/webroot/sage directory
- (please post any custom CSS files -- if there is enough positive feedback, I will make this option more user-friendly!)
- add mime.types file (with mp4)
- Show media library info on Home page, and include media library rescan function
- Add video conversion management.
- Individual Conversions can be started from detailed info, and grouped conversions from recordings lists
- Add ability to power off or reboot an MVP from the webserver.
- Add ability to exit a placeshifter client from the webserver.
---- v2.16 04 Jun 2007
BUGFIXES
- fix EPG views to italicize watched shows
- fix Home page not to exception when nothing scheduled
- Edit Show info: fix generated EPGID to not look like an Episode ID
- Edit Show info: keep Channel Info when re-creating airing
- Edit Show info: Catch and report 0-lengh airings
- Edit Show info: Restore pre 5.0 compatability
- Put a detailed Info link on all elements of airing cells
- use '&nbsp;' for blank titles (so that they get a link)
- remove min-width CSS (triggers Firefox rendering bug)
- RSS: use time zone offset rather than timezone name (+0200 in place of CEST)
ENHANCEMENTS
- create a reasonable-sized preview image when viewing Picture details (SageV6 on)
WARNING: Due to a collection of bugs, this version requires Java 1.5 or 1.6 (recommended) and Picture preview requires SageTV6 or higher.
---- v2.15 04/May/2007
BUGFIXES
- Corrected property name in transcode.properties.
- Fixed intelligent suggestions grouping
- Fixed transcoding modes list layout
ENHANCEMENTS
- Added past/future/Recorded Files search links in TV search results
- Added ability to page results in all views (useful if you have a lot of recordings or a small screen)
- Better recordings management (added group selection, group actions, multi-file delete)
- More actions in search results for TV files (eg delete)
- Added Grouping in search results
- Import of Favorites, Airings and MediaFiles? from exported XML files
---- v2.14 29/Mar/2007
BUGFIXES
- Transcoding now works on segmented files
- better logging for transcoder
- Quotes paths in transcode.properties
ENHANCEMENTS
- added ToonGal's Full webremote (and ability to switch between them)
- added ability to name extenders using 'extenders.properties' file
- (paused) indication on Home screen for paused playback
- added link to search for file on Orb
- basic streamed DVD transcoding added (only title 1 with the default audio track)
---- V2.13 Mar 20 2007 For SageTV 2.2-6.1
BUGFIXES
- v2.12 only worked with SageTV6, this version should restore backward compatability.
---- V2.12 Mar 20 2007 For SageTV 2.2-6.1
ENHANCEMENTS
- Windows installer package to make installation a breeze
- UPnP port forwarding support
- (jreichen) Next Scheduled Recording on Home page
- (jreichen) Mark Conflicts in Guide, Search Results, and Detailed Info
- (emok) Added transcoding of video files with VLC for low-bandwidth video streaming (see WebserverTranscode)
BUGFIXES
- Fixed folder rendering bug on Opera
- (jreichen) Fix file size on Search Results page (find media file associated with airing)
---- V2.11 Dec 22 2006 For SageTV 2.2-6.0
Jreichen's changes: BUGFIXES:
- Webserver: An extra directory named 'webserver\log' was created on Linux. Log file names were 'log\AWS*'.
Fixed them by using / as separator character on Linux. - Detailed Info: Workaround for NegativeArraySizeException thrown by HasAlbumArt.
It still prints an exception to the console, but not to the web page. - Detailed Info: Exact Title was not being used for Additional Airings
- Favorites: Fix Firefox tooltips.
- Favorites: Add padding tooltip.
ENHANCEMENTS:
- EPG guides: Add episode id to guides
- Favorites: Show 'Default' in Favorites Manager for favorites with default recording quality.
- Search: Add Search by Filename
nielm's changes: ENHANCEMENTS:
- MediaFileDownload: Estimate total size for currently recording streaming files, allows playing while recording and seeking
---- V2.9 Oct 01 2006 For SageTV 2.2-5.0
Jreichen's changes:
EPG views:
- ENHANCEMENT: Add HD and First Runs markers to EPG guides
- ENHANCEMENT: Add NEW EPG Channel View
- Default EPG Channel View to start at midnight
- BUGFIX Some font sizes on EPG Grid View and EPG Search pages were being reset when Firefox went into "quirks mode". It shouldn't be going into quirks mode based on the DOCTYPE declaration, and refreshes of the same page may change the mode. Possible bug. Firefox 1.5.0.6 Windows XP.
Search:
- ENHANCEMENT Add HDTV, FirstRun/ReRun? and Archived options to Search Criteria
- ENHANCEMENT Add RSS feed for search results
- BUGFIX Query string is already encoded. When clicking the Set button, the query string is encoded a second time and there are no results when the page refreshes.
Favorites:
- ENHANCEMENT Add columns for favorite properites to cells in FavoritesServlet?.
Detailed info:
- ENHANCEMENT Show scheduled encoder in detailed info page of scheduled
recording.
- ENHANCEMENT Show 'year' and 'runtime' in detailed info (if data is present, eg for movies)
Various fixes:
- BUGFIX Add nowrap property to markercell class
- ENHANCEMENT Add ratings marker columns to airing cell and detailed info.
- BUGFIX Fix exception written to web server log file when creating a manual recording. java.lang.IllegalStateException?: Already was returned as servlet output stream
- BUGFIX Change Mb -> MB
Nielm's changes
Edit show info:
- temporarily remove buggy 'keep EPGID feature'
- ENHANCEMENT: Home page now displays number of resolved and unresolved conflicts
- ENHANCEMENT: better generation of RSS urls
- BUGFIX: epg links for currently recording shows now work
---- V2.8 Apr 07 2006 For SageTV 2.2-5.0
- BUGFIX: search pages are correct now
- BUGFIX: Favorite priority setting now works again
- BUGFIX: Changed action links into real buttons (avoid possible pre-caching problems)
- ENHANCEMENT: Added num resolved conflicts to home page
- ENHANCEMENT: IR suggestions RSS feed, Conflicts RSS feed
- ENHANCEMENT: Removed authentication for RSS feeds
-- (Record Schedule RSS feed path has been changed you will need to re-add the feed to your reader) - ENHANCEMENT: Added XML output for conflicts
---- V2.7 Mar 24 2006 For SageTV 2.2-4.1
Nielm's changes
- NEW FEATURE: most pages that display information can now have xml output
-- add xml=yes parameter on URL, or look for the [xml] icons
-- see SageXmlInfo - ENHANCEMENT: allowed new favorites to be added with a default priority
-- (allows adding faves from an external program) - ENHANCEMENT: Edit Show info allows keeping same EPGID, or specifying a known EPGID
- ENHANCEMENT: version/last updated/validation links on every page
- ENHANCEMENT: Recording Schedule RSS feed.
- ENHANCEMENT: EpgList? view: word-wrap titles, and only crop vertically
-- (this may cause problems on browsers that do not support CSS overflow-x and overflow-y properties) - BUGFIX: XHTML validation fixes for various pages.
- BUGFIX: Favorite creation: check that at least one title/category/person/keyword is specified
- BUGFIX: command buttons no longer add '&' characters to the URL
Jreichen's changes:
- ENHANCEMENT: Add/remove manual record status, remove archive status in detailed Info page
- ENHANCEMENT: Add/remove archive status in Search results
- ENHANCEMENT: Add Original Air Date in Detailed Info
---- V2.6 Jan 20 2006 For SageTV 2.2-4.1
- BUGFIX: fixed gzip encoding for browsers that do not support it (fixes media player)
- BUGFIX: hopefully fixed home/detailed info/webremote pages for sage 2.2-4.0
- BUGFIX: fixed display of marker icons for Airings.
- BUGFIX: removed manual recs from partials filter in search
----
V2.5 Jan 19 2006 For SageTV 2.2-4.1
Nielm's changes:
- BUGFIX: hopefully re-added compatibility for sage 2.2-4.0 versions (thumbnails will still not work)
- BUGFIX: hopefully made HDTV icon work now
- BUGFIX: hopefully fixed streaming video player for HTTPS
- BUGFIX: Fixed 'Play in SageTV' button
- BUGFIX: Fixed Manual Record/Set Padding in non-service mode/client webservers.
- BUGFIX: Gb -> GB, Mb -> MB
- BUGFIX: Got rid of annoying 'Capture Device' media files in library search
- NEW FEATURE: Added experimental support for gzipping servlet output -- makes large pages much faster on slow internet links.
Disable with property: nielm/webserver/enable_gzip_encoding=false - NEW FEATURE: find media file details by passing file name in path.
This works for any page that accepted the 'MediaFileId?' argument, eg:http://server:8080/DetailedInfo?FileName=c:\path\to\file.mpg http://localhost:8080/sage/MediaFileCommand?command=WatchNow&context=SAGETV_PROCESS_LOCAL_UI&FileName=c:\path\to\file.mpgNote: Filename must exactly match name in sage's DB (ie using UNC paths etc) - ENHANCEMENT: Picture thumbnails are now extra-small in search results -- saves bandwidth
- ENHANCEMENT: Improved handling of folders in Sage Recordings -- folders now open containing content and toggle open/closed.
- NEW FEATURE: Added Intelligent Suggestions screen -- shows what would be recorded if Intellgent Recording was enabled (4.1+ only)
Jreichens changes:
- NEW FEATURE: View Partial and Auto-Delete Recordings: Provide links to, and size of, partial and auto-delete recordings in the Home Screen
- ENHANCEMENT: Added filters for partial and auto-delete recordings on the search page.
- ENHANCEMENT: Enhanced Recording Quality Info in favorites and Detailed Info page
- ENHANCEMENT: Favorite priority can now be set to 'above' or 'below' another favorite -- quicker than re-ordering with arrows
----
- For SageTV 4.1 and later only
- BUGFIX: Removed 'null' menu items
- BUGFIX: Channel logos default to enabled
- BUGFIX: Fixed webremote and Sage command functionality for v4.1
- ENHANCEMENT: Added now playing info for media extenders
- ENHANCEMENT: Added WebRemote? for media extenders (click the extender name in the Home page)
- ENHANCEMENT: Added Show marker icons to show display (optional default=on)
- ENHANCEMENT: Added File size indication to show display (optional default=on)
- ENHANCEMENT: Added Episode ID to show display (optional - default=off)
- ENHANCEMENT: Fallback menu for browsers that support JavaScript? but not JavaScript? DOM (eg Pocket IE)
- BUGFIX: Added more protected paths for write:only user.
- ENHANCEMENT: Added support for picture/album/mediafile thumbnails
---- V2.3 Dec 9 2005
- BUGFIX: Fixed bug where returning to a list of items after setting flags did not work (eg setting dont like on Search results / Sage Recordings / Recording Schedule)
---- V2.2 Dec 8 2005
- BUGFIX: Lots of i18n/charset handling fixes for parsing parameters in webserver code...
Should now handle non-latin charsets perfectly
Due to above, the following are fixed:
- BUGFIX: Favorites: adding a fave for a title with a '&',
adding a fave for a channel with a '&',
adding a fave with any special non-7-bitASCII characters
- BUGFIX: Search: searching for anything with a '&' or special characters
- BUGFIX: Edit show info -- fixed problem when special (non-Latin-1) characters (such as Accented/Greek/Hebrew/Arabic)
- ENHANCEMENT: improved favorite re-ordering by jumping to re-ordered favorite, numbering rows, and keeping changes out of browser history.
---- V2.1 Dec 6 2005
- BUGFIX: fixed media player page when no supported players installed
- BUGFIX: jump to channel in EPG views in IE...
---- v2.0 -- 6 Dec 2005
- NEW FEATURE: Favorites Management -- Add/remove/re-priority favorites
Big thanks to jreichen from the Sage Forums for implementing this.
- NEW FEATURE: Web-based media player
Click Watch Now on any recording in the detailed info screen
Or Listen for MP3 files...
Very simple for the moment... requires additional web-browser plugins for MPG and AVI playback
Best results using IE (Sorry. I hate browser-dependant stuff!)[
No re-encoding support -- you download the original files...
see WebServerMediaPlayer for more information
- BUGFIX: fixed Sage mediafile download so that no password is required
- BUGFIX: fixed Sage mediafile + webserver normal file download to support HTTP Range requests
!!! Seeking in streaming files now possible with supported players !!!
- BUGFIX: webremote and about pages now have a menu bar!
- BUGFIX: changed TvTome search to TV.com
- ENHANCEMENT: included ajuhawk's Sage Encoder support.
set the property "nielm/webserver/enableSageEncoderOpts=true" to enable
- ENHANCEMENT: Detailed Information pages now have streaming and file-based playlist links.
This allows one-click access to files in external media players
- ENHANCEMENT: Add'l Tracks by artist / Tracks on album buttons in detailed info
- ENHANCEMENT: improved menu bar --
IMPORTANT: menu.properties is no longer in use.
menubar definition can be edited in webserver/webroot/sage/menu_items.js
No more restarting sage for menu changes
- ENHANCEMENT: Added Sage Recordings and Media Library searches to menus.
- ENHANCEMENT: Fallback main menu for non-Javascript browsers.
- ENHANCEMENT: jump to a channel in EPG views
- ENHANCEMENT: jump to options block in Sage recordings on [show options]
----- v1.6 -- 15 Jun 2005
- BUGFIX: corrected caching of static files (affected mainly Opera, but should make all browsers quicker over slow networks)
- BUGFIX: record options back for currently recording manual recordings.
- NEW FEATURE: automatic download links for all media files -- no need to mess around with paths.properties etc
note that this means MP3s can be streamed into WMP, and JPGs viewed in browser but for AVIs and MPGs, you have to download, or need a media player that supports HTTP streaming for AVIs and MPGs. The only one I know of is VideoLanClient.
---- v1.5 -- 25 May 2005
- Hyperlinked search for people in detailed info page (both in EPG and in IMDB)
- Hyperlinked TvTome search in detailed info
- Corrected default Search options
- Removed annoying !Onclick javascript in EPG cells (allows open in new page)
- Fixed bug where IE sometimes returned blank pages
- Fix line breaks in detailed info
- Add 'Recording' icon to search and EPG pages indicating a scheduled recording
- Fixed broken Favicon
- Catch socket errors in FileServlet (prevents too much logging when clients abort connections)
- Improved DetailedInfoServlet and WebRemote to use javascript to send commands -- They should respond much faster, and no longer create multiple entries in history
- Channel logos in detailed info.
- Channel logos now on by default and automatic (it gets them from SageTV)
- Added menu items to search for watched + Don't like shows.
---- v1.4 -- 1 May 2005
- Fix force EPG update button
- Workaround annoying Firefox EPG-Grid bug which means that pageup/down arrows don't get drawn sometimes (EPG channel cells with arrows no longer line up nicely... Uncomment the 'Firefox bug workaround' block in sage_all.css to restore proper behavior on other browsers)
---- v1.3 -- 29 Apr 2005
Global:
- Fix bug in search where detailed info could not be displayed for results with mediafiles
---- v1.2 -- 28 Apr 2005
Global:
- Use 'all' CSS media type
- Add timeout for pull-down menus
- BUG: check for UI on SageCommands/PlaybackCommands
- BUG: corrected spelling of Episiode
- better display of !Music/Picture file information.
- highlight EPG cell focus (except in IE), sports, movies, news (using same criteria as sage)
- clicking on EPG cell background (as well as text) goes to detailed info
- included Wheemer's Web-remote
Timed record:
- BUG: Fixed month selection in timed record
Conflicts:
- BUG: manual/favorite conflict confirm now works
EPG grid/list:
- lowlight airings in the past
- highlight focus (except in IE), sports, movies, news
- jump to options on [Show Options]
Home:
- Added Force EPG update button to Home screen (only appears if last update was more than 1 min ago)
Detailed Info:
- Add FirstRun/ReRun to Detailed Info screen
- Improved setting padding on manual records (no more entering -5 mins!)
- Show AiringID, MediaFileID in detailed info
- Add ParentalRating to DetailedInfo
- include 'Archived' indication
Search: Big re-work!
- pages of results
- no more grouping
- Searching within other fields (such as people)
- custom sorting
- search for airings or mediafiles
- fixed bug where Search does not cope well with categories with special characters
Experimental new feature:
- Edit EPG info for a show: Allows DB information to be added for video files
---- v1.1 -- 19 Nov 2004
Bugfixes:
- Better handling of invalid values in sort/filter/group options
- Delete file when running in SageTVService now works
---- v1.0 -- 18 Nov 2004
- Initial release
----
Credits
The Sage Webserver uses a modified version of the Tiny Java Web Server, which is itself derived from the Acme Java Web Server (copyright notice).
The modified TJWS source code is available in CVS
The WebRemote page was written by Wheemer
Favorites support was written by jreichen
Thanks to ErstatzTom for the Sage Community hosting, and to Sourceforge project CVS and project Delivery hosting.
Licence
The Sage Web Server Plugin is licenced under the BSD licence, which basically means that you can do what you like with it, so long as you give me credit, you get no warantee/guarantee of fitness for purpose, and cannot blame me if things go wrong!
All source code can be found in CVS at Sourceforge - webserver sub-project (or browse it via WebCVS)
The Recording Schedule RSS feed uses the LGPL licenced jrss RSS java classes"Families is where our nation finds hope, where wings take dream."
