Jetspeed 1.0 TODO
Last Modified: $Date$
Latest version at: http://www.working-dogs.com/jetspeed/cvsweb/index.cgi/jetspeed/docs/misc/  
Author:  burton@apache.org

*************************************** TODO ***********************************

******* REQUIRED DOCUMENTATION FOR 1.2 ********

- Better documentation on the control panel and daemons is required for 1.2

- Document how the PortletRegistry works.

- Document properties files better

- Document the daemon package

- Document the Admin console

- Document how the updated FeedDaemon works

- Document how user customization works

- ... on JCM, what it is and how to use it.
    - describe what the bookmarklet does
    - tell them that it stores the password in clear text

- Documentation on how to setup user authentication

- Docs and a dist of Turbine for setting up SQL
    

****** HIGH PRIORITY ****** 
- Moreover links seem to fail within Jetspeed.  The reason seems to be that if can't
  figure out that the URL is really in the cache.

- Put the XML.com jetspeed article within sitebook

- BUG: FileServerPortlet doesn't not expire itself when running under Tomcat

- FEATURE:  Modularize the FileWatchPortlet.  Create a FileWatcher object.  This
  object should throw an IOExcpetion on the constructor if the file does not 
  exist.  Then use this in the CocoonPortlet to see if you can expire the 
  portlet when its stylesheet (IE not URL) changes.

- BUG:  If the PortletRegistry receives another Application then the 
  Applications Portlet isn't smart enough to realize that its content has
  changed.  It needs to expire itself

- BUG:  Cocoon won't update itself when stylesheets change on disk.  This needs 
  to be fixed because if you update a stylesheet, Jetspeed only picks this up
  when you restart it

- BUG: Check the following when Jetspeed is started:
    - use the Turbine RequiredLibraryManager to check for all required libs.
    - Check that JetspeedResources.properties is actually there
    - Check that /tmp/JetspeedDocumentCache is there and is writable
    - Make sure that the Cocoon XSP repository is writable

- BUG: Make sure that portlet property inheritance works.

- BUG:  RSSPortlet/FileWatchPortlet may not be updating itself from disk 
  correctly.  Either that or the DiskCacheDaemon might not be working correctly
    - This is a problem with either the FeedDaemon or the DiskCacheDaemon.
      The RSSPortlet correctly updates itself but it appears that the daemons
      don't work    

- Make sure that Admin portlets can't be instantiated from not within the
  Admin screen.

- BUG: When running in a new Servlet Context under Tomcat (reported by Neeme Praks):

> I have context for jetspeed set to "/jetspeed" and I have my XSP file in
> http://myhost/jetspeed/myfile.xml, the physical path is
> root-to-tomcat\webapps\jetspeed\myfile.xml (Win2K system). When
> resolving the URL to physical, JetspeedDiskCache returns
> file://root-to-tomcat/webapps/jetspeed/jetspeed/myfile.xml.
> As much as I understand, EngineContext.getInstance().getDocumentRoot()
> returns root-to-tomcat\webapps\jetspeed and then the
> /jetspeed/myfile.xml from URL is appended to this, resulting in one
> extra "jetspeed". Haven't figured a way out yet how to fix this...
   
  
****** NORMAL PRIORITY ****** 

- Improve Portlet subcription.  You should be able to pick from a couple of
  generic portlets.  Then you should also be able to search from additional
  portlets using keywords (from OCS) or domain name.

    - Portlets should have the the ability to be added to a users profile so 
      they when they logon they get their own profile and their own portlets.


********************************** 1.2 *****************************************

 
********************************** 1.3 *****************************************

- Rework the way navigations are used with Turbine/Jetspeed.  Make it possible
  to kill these off via specifying them in the URI.

- Write a portlet that allows the USER to input a remote URL into Jetspeed.
  This URL should have some tags stripped.  <html> <body> <script>
 
- Serve PSML and user XML files from /content/users/[USERNAME]

- CocoonPortlet.  Use the stylesheet URL in the XSP document but if the Portlet
  defines a "stylesheet" property this should override the XSP stylesheet.  
  The CocoonPortlet should be enhanced to support multiple content types though
  in most situations (99%) the default stylesheets will be used.

- Move all Util.globalStringReplace() functionality to use StringUtil.replace

- When the user goes to the PortletViewerScreen put some standard Portlets 
  around the content.  For example also put the Applications Portlet, Polling 
  portlet, etc

- The ability to publish HTML documents on a specific URL as content within 
  Jetspeed and through the Admin interface.  Mark these in some way so that they
  become "editorial" pieces.  This has the benefit that these pieces can be 
  discussed in the Forum code.  These should appear under a "Features" portlet.
  
- Write an "uptime" portlet so that it shows how long the Virtual Machine has 
  been running.
  
- Write a "bookmark/favorites" Portlet.
  
- Add polling/voting support as a Portlet

- Add support for submiting an Article to the site maintainers (these should be
  the standard JCM maintainers)

- The RSSPortlet should only expire itself when its on-disk content actually CHANGES
  right not it is just auto-expiring after a fixed interval. Consider putting 
  this code into the AbstractPortlet as the default behavior.

- In the PortletRegistry add/remove/get methods should throw a RegistryException
  to tell the user if the operation worked.  This should fix a bug with the 
  MemoryStore expiration code that causes a RuntimeException

- JCM: Send an e-mail off to users when content is published.

- JCM: add a maximum topic count so that the end of the list get's chopped of 
  and web pages don't keep going on forever.

- Put the remote image disk buffering code back in.  This was removed due to a 
  bug and the fact that we migrated over to XSP.  This should be a trivial tweak

- On the JCM Admin page add a section for posting this URL to XMLTree.

- Add some statistics to the top navigation:
    - current number of portlets
    - current number of users

- Fix the bug with the threadpool.  I should be able to create as many threads
  as I want and there should be *NO* stall points.  Also, all VMs should not
  crash/stall/etc.

- JCM: improve content administration:  
    - ability to add/remove/modify topics
    - ability to add/remove/modity items
    
- XML: - pretty print all XML when you save it do disk
       - make backup when you save XML to disk

- in JCM automatically add the additional fields (pubDate,etc

- Have an attribute on "entry" named "hidden" and if true this Portlet/Entry
  is never browsable.

- (DONE) rework the PortletBrowsing support:
    - (DONE) should allow you to browse by title and description (remove URL).  When
      (DONE) you click on the title it should allow you to "preview" this item.  

    - Should allow back and forward navigation and handle the begin and end points
      OK.
    - Should handle a situation where there are no portlets and give the user
      a decent message

- Meerkat (http://www.oreillynet.com/meerkat) style content functionality.

- Ability to dock Portlets into the Mozilla sidebar.

- Portlet content delivery via e-mail.

- Add the capability so that a Portlet can become detached from the web browser
and "remote/floating"

- Don't call init() within Home.  Instead make the DaemonFactory a Turbine Service
  that should be initialized.  
    - we will need to use the latest Turbine from CVS for this feature.
    - this is also necessary because jetspeed will totally screw up if requests
      come in while it is trying to be initialized.  Try to make this 
      synchronized so that multiple things don't happen at once.

- Improve the DiskCacheDaemon.  Don't constantly pull down resources.  Instead
  only download resources that have changed.  This should improve performance
  and reduce network activity.
    - Use the OCS meta information to put in the minimum download interval and 
      don't download a new version even if this has changed.

- JCM:  Support a <from> element on an item which should be the server name
  where this URL was published (EX: java.apache.org).  This way we can have an 
  item come out with:
  
             blah blah blah.  From: java.apache.org
             
             - and in this situation java.apache.org would be an HREF

- JCM:  Under the /content/channel/item/description element add some formating 
 options:
    <b>
    <i>
    <p>
    <br>
    
- Create a "Logon" Portlet that should replace the current Logon screen.  The 
  link on the navigation screen to logon should point to the new Portlet and 
  also put this new portlet into the default PSML under Applications

- The DiskCache and RSSPortlet are not correctly putting the Jetspeed images from
  RSS into the public cache.  The image isn't comming up in the web browser but
  is coming from a remote HTTP server.  When the RSSPortlet is parsing the DOM
  make sure it get's the URL from the remote server.

- Manage PSML better.  
    - Do xerces schema validation when parsing the contents.
    - Cache the documents after they are parsed out so that there is no 
      performance hit when someone wants their preferences
    - If documents are modified on disk outside of Jetspeed reparse these out.

- Build in a way to keep rendered Portlets persistent so that they survive 
  server restarts.  The PortletFactory should check a separate disk cache after a 
  MemoryStore cache fetch fails.  The content should be parsed out and stuck 
  back into the Portlet with a ClearElement.  Portlets should be able to 
  override this so that if they don't want the data the can veto this.
    - This is a very important feature.  The FeedDaemon should instantiate all
      portlets so that their HTML can be saved to disk.  This way the can 
      be swapped into memory very easy.  The FeedDameon will then instantiate 
      all Portlets and assume they are in memory... some may be swapped out but
      the PortletFactory can swap them back in if necessary.
    - How is this integrated into Cocoon/Cocoon 2.0?

    - See if this actually provides a speed improvment.  Meta info will have to 
      be stored on this disk and this basically means we have to use Castor which
      would negate any performance improvement we would achieve.

- integrate the Javacorporate Forum code.
    - Discussion portlet which obtains it's information based on another portlet.  

- Track the last time a daemon has run and also the total time it took the 
  daemon to process.

- Provide a Portlet expiration mechanism in XML.  This should markup when a 
  portlet should be expired and the PortletFactory should override the Portlets
  schedule with the content in the XML.  This should be placed in the queue when
  it expires for redownloading.

- Add support for a Portlet "state"

    Include the state in the cache engine so that different cache states are 
    correctly displayed.
    
    this.getPortletConfig().getState()
    
    - STATE_NORMAL
    - STATE_MINIMIZED
    - STATE_MAXIMIZED
    
    This is necessary so that portlets can determine how much information 
    to display when the user changes their state.  For example a maximized
    portlet might display extra graphics, etc.

- Also consider having meta-info for the width and height of the portlet 
  (narrow, wide, tall, short, etc)

- Redo the stylesheet so that everything has an entry (portlet-background, etc)
  Then with a tool the user could generate their own stylesheet.

- Ability to set the refresh rate within portlet markup.  This would override 
  the refresh rate on portlets that specify their own refresh rate.

- Improve RSS support.  Only use 1 stylesheet this should be *very* smart and 
  work across RSS 0.90, 0.91, and 0.92.  
    - it is important here that we still use the RSS parser to pull the images
    locally but use an XSLT for the UI
  
- require all portlets to use XHTML.  Then we can process the <form> data
  and add namespaces within the Factory and pull them out when we call
  service() on a Portlet