FrancoToile

Getting used to using an svn repository. Exported the site from eXist using the jnlp client, put the contents in the trunk folder on local drive, cleaned out extraneous files (__comment__), added to repository.

The francotoile SVN repository is at
https://revision.tapor.uvic.ca/svn/francotoile/
The data folder (for francotoileeditors) is at
https://revision.tapor.uvic.ca/svn/francotoile/trunk/db/site/data

Greg created a francotoileeditors group with CC and ES as members, they have rw access to the data folder, but no access beyond that.

To create a copy of the data folder on local drive (instructions for a Mac)
- start : Terminal in Applications/Utilities
- type : cd Documents
- press : enter key (to move to the Documents directory)
- type : mkdir FrancotoileData
- press : enter key (to make a folder called "FrancotoileData" in the Documents folder)
- type : cd FrancotoileData
- press : enter key (to move to the FrancotoileData folder)
- type : svn checkout https://revision.tapor.uvic.ca/svn/francotoile/trunk/db/site/data/ . (note the space and period at the end, those are critical)
- press : enter key (that will make a copy of the data folder on the server to the FrancotoileData folder on your computer and set up the version control system

You're now ready to edit the files on your local computer just as you would normally.

At end of each session :
- click : on the icon for the running Terminal application or start Terminal and cd to your data folder
- type : svn commit -m "brief description of what you did here"
- press : enter key (to synchronize files on the server with those from your computer)
- quit Terminal

At start of each session (other than the very first when you checkedout the repository) :
- start : Terminal in Applications/Utilities
- type : cd Documents/FrancotoileData (or whatever you called your data folder)
- press : enter key (to move to your data folder)
- type : svn update
- press : enter key (to synchronize files on your computer from those on the server)

CC noticed that in a full transcript, if there is a link (<a href="#" class="tooltip">) on the bottom line of text that causes a popup tooltip thingee to appear below the text, that div appears outside the viewport on the page. The page generates a scrollbar to (in principle) allow the user to scroll down to see the gloss, but if the user moves the mouse off the link, then the gloss window disappears.

I added some padding to the bottom of the detailpanel div (which contains the full transcript) - enough to accommodate a three or possibly four line gloss. The popup handling in the individual subtitles positions itself properly, so is not an issue.

I uploaded index.xql, player.xql, search.xql and transcript.xql from the dev site on my computer to the production site on pear. I also uploaded the plugins/hcmc-utils collection (contains hcmcutils.xql). Revised site seems to be working OK. Mechanics took a while as the client in Oxygen would copy the hcmcutils collection, but not the individual xql files, so I had to use the exist admin client for the four individual files.

You can't put xql logic up with the declare statements in the head of the xql file. So, if you need to modify any of those dynamically, here's what you do:

1) hard code in the default case

2) write a function that tests the condition(s) you care about

2) then in the part of the file that is actually processed (and that seems to be anywhere within the root element (e.g. html)), invoke the function and then for each value returned by the function use a util:declare-option statement.

For example, if I want to write out one exist:serialize argument for IE and another one for all other browsers:

1) hard-code the default case (i.e., the one that works for all browsers other than IE) as usual near the top of the file :

declare option exist:serialize "method=html5 media-type=application/xhtml+xml encoding=utf-8 indent=yes doctype-public=''";

2) write a function that tests the condition you care about and put that up at the head of the file too (declare the namespace if necessary):

declare function local:isIE() as xs:boolean{
let $user-agent := request:get-header("user-agent")
return
if (fn:contains($user-agent,"MSIE"))
then (true())
else (false())
};

3) somewhere within the html element invoke the function and re-declare the option:

{if (local:isIE())
then (util:declare-option("exist:serialize", "method=html5 media-type=text/html encoding=utf-8 indent=yes doctype-public='' "))
else ()
}

I'm not sure if there are any constraints or best-practices regarding where to put the test and redeclaration, but in my brief testing it doesn't seem to matter.

The website is located at: http://francotoile.uvic.ca

... which is a virtual host that points to: http://pear.hcmc.uvic.ca:8081/francotoile/francotoile/index.xql

the FrancoToile app lives in the webapps-dev directory on Pear. All of the non-essential web interfaces (the admin interface, eXide, the help docs, etc.) have been erased from the app to limit the possibility of unauthorized access.

To connect to the database: see the ODT file for connection information.

The eXist version of the site uses much of the same HTML/CSS from the PHP version, as done by Pat Szpak.

State of the Website

The site is complete aside from the odd tweak and language-related fix that Catherine sends in. All of the features work, the code is documented, and everything is running smoothly.

The Bookmarking System
(taken from: http://hcmc.uvic.ca/blogs/index.php?blog=12&p=8271&more=1&c=1&tb=1&pb=1 )

Adding a Bookmark

When a user adds a bookmark, an AJAX request with the video ID, the timestamp, and any optional comments is sent to plugins/bookmarks/ajax/add.xql. This XQuery script returns a JSON object with the ID (i.e. bookmark/@n) of the new bookmark, the timestamp, and the comments if applicable. The add.xql script actually returns XML that is passed through the eXist JSON serializer:

declare option exist:serialize "method=json media-type=text/javascript";  

If the bookmark can't be added, which happens if the video ID is invalid, then a 500 error is returned.

Upon successful addition, the JSON response object is parsed by the calling Javascript, which adds a list element to the ordered list of bookmarks.

Deleting a Bookmark

Deleting a bookmark (clicking on the 'X' image next to the bookmark in the ordered list) simply removes the bookmark from the DOM. Bookmark data files are never actually deleted from the server.

Saving Bookmarks

Saving a bookmark list requires no AJAX interaction with the server. Rather, all of the bookmark IDs are gathered from the ordered list of bookmarks (each of which has an ID of bookmark-## where ## corresponds to bookmark/@n in the XML data) and then simply appended to the URL of the video page. This URL is given to the user, who can add it to their bookmark collection for later use. The ids are added as comma-separated values of a "bm" GET parameter. For example: player.xql?id=fraq1&bm=54,55,56

Loading Saved Bookmarks

When a user visits a video with a bm query string (see 'Saving Bookmarks' above), an AJAX call is sent to plugins/bookmarks/ajax/load.xql for each bookmark ID in the query string. Upon successful load of the bookmark - success means that the ID corresponds to bookmark/@n and the current video corresponds to bookmark/@videoId - a JSON-serialized XML node is returned (see 'Adding a Bookmark' above), which is then used to populate the unordered list of bookmarks.

Future Data

As stated on the blog ( http://hcmc.uvic.ca/blogs/index.php?blog=12&p=8288&more=1&c=1&tb=1&pb=1 ), the XML data files on Pomme have been moved to an inaccessible location, in the interests of maintaining a single set of up-to-date files (i.e. the ones on Pear). When Catherine is ready to start working on the site again, Pomme should be updated with the latest version of the files from the Pear eXist DB.

The movies at http://francotoile2.uvic.ca used as a base URL: http://francotoile.uvic.ca/media/

When the eXist site was switched to francotoile.uvic.ca, however, those paths became invalid. So, I updated the movie player to use the 'real' base URL on lettuce: http://lettuce.tapor.uvic.ca/~florevid/media/

This is a decent temporary solution, but I will experiment with putting the media files on the Pear file system and then using an XQuery script to stream the videos, rather than using lettuce.

***per Jamie's idea, how about a mod_proxy def. like:
http://hcmc.uvic.ca/$projName that resolves to a /home1t/$projName/media/ folder
so projects serving media can use a URL like:
http://hcmc.uvic.ca/florevid/media/somevideo.mp4

After digging in our heels and grunting through a bunch of Apache rewrite rule combinations, Greg and I came up with a VirtualHost entry for francotoile2.uvic.ca that does the job, in that http://francotoile2.uvic.ca points to http://pear.hcmc.uvic.ca:8081/francotoile/francotoile/index.xql . Getting it to work basically just came down to trying a lot of different combinations of various RewriteRule and JKMount lines until something worked. We gave the VirtualHost stuff to ER at systems who implemented it (and expanded it a bit). Here's the working entry:

<VirtualHost *:80>
  ServerName francotoile2.uvic.ca
  DocumentRoot /home1t/florevid/www
  RewriteEngine On
  RewriteRule  ^/$  /index.xql
  RewriteRule ^(.*)$ /francotoile/francotoile$1 [PT]
  JkMount /francotoile/francotoile/ dev
  JkMount /francotoile/francotoile/* dev
  ErrorLog "|/usr/local/sbin/cronolog
/usr/local/apache2/logs/francotoile.uvic.ca-error_log.%Y%m%d.%X"
  CustomLog "|/usr/local/sbin/cronolog
/usr/local/apache2/logs/francotoile.uvic.ca-access_log.%Y%m%d.%X" combined
</VirtualHost> 

Now we're just waiting on ER to point the Pear site to http://francotoile.uvic.ca instead of francotoile2, which'll wrap up the new version of the site.

The goal is to have http://francotoile2.uvic.ca/index.xql point to http://pear.hcmc.uvic.ca:8081/francotoile/francotoile/index.xql .

Currently, points to http://francotoile2.uvic.ca/francotoile/francotoile/index.xql . I haven't been able to accomplish this at the eXIst level; this may need to be done in either Tomcat or Apache.

I've tried the following things in francotoile/WEB-INF/controller-config.xml with no success:

• Changing this:

  <root pattern="/francotoile" path="xmldb:exist:///db/francotoile"/>
  

  To this:

  <root pattern="/" path="xmldb:exist:///db/francotoile"/>
  

• Commenting out all <root pattern...> elements and adding this:

  <root server-name="francotoile2.uvic.ca" pattern="/*" path="xmldb:exist:///db/org/site1/"/>
  

Due to a recent change in Google's map JS API (who knows what that change is), I've had to change the map page to be served as text/html rather than application/xhtml+xml. Here's the comment that I put in the HTML source on the eXist version of the site:

    July 05/2011, Jamie Nay:
    This page is served as text/html rather than application/xhtml+xml because the Google Maps JS API uses document.write to write elements to the DOM, which isn't supported by XHTML.
    Google knows about this issue ( see http://code.google.com/p/gmaps-api-issues/issues/detail?id=530 and http://code.google.com/p/gmaps-api-issues/issues/detail?id=2820 ) but won't fix it. Instead they suggest a
    workaround (better known as a hack): passing a callback function when loading the API script.
    
    Unfortunately, neither this:
    
    <script type="text/javascript" src="http://maps.google.com/maps/api/js?sensor=false&callback=initialize"></script>
    
    Nor this:
    
    <script type="text/javascript" src="http://www.google.com/jsapi"></script> 
    <script type="text/javascript"> 
    google.load('maps', '3', {'other_params': 'sensor=false', 'callback': initialize});
    </script>
    
    Seems to work; I've tried both approaches (loading the API directly and using google.load). The bottom line seems to be that, no matter what workaround you try, you just can't load the API properly while serving your
    content as application/xhtml+xml.
    
    Prior to early July/late June 2011, the API was being loaded successfully because I had put in a document.write clone script that I found at: http://weston.ruter.net/projects/xhtml-document-write/
    
    That script added document.write support to pages served as application/xhtml+xml. However, due to what I can only assume is a recent change in the Google API, this fix no longer works and the map does not display correctly under any circumstances when serving with the xhtml mime type. So, the only feasible solution in terms of time and effort spent is to serve this map page as text/html. If there's a pressing need to serve as application/xhtml+xml in the future then this issue needs to be resolved. For now, however, text/html is doing the job.

eXist comes with a "debugger" extension (or "debuggee", depending on which area of the code you look in), which is disabled by default. To enable XDebug in an eXist application:

1. Build and deploy eXist: http://hcmc.uvic.ca/blogs/index.php?blog=11&p=8146&more=1&c=1&tb=1&pb=1

   • Important:When editing local.build.properties, set include.feature.debugger to true

2. Copy:

   (exist source directory)/extensions/debuggee/lib/mina-core-x.x.x.jar

   To:

   (exist deploy directory)/WEB-INF/lib

Part two will cover actually using the debugger to step into a running script, once I figure out how to do that.