User:Quarl/userscript.js: Difference between revisions

// User:Quarl/userscript.js - utilities to help develop user scripts

// - adds "raw" tab to user script pages
// - adds "refresh" tab to user script pages (refresh the raw script)
// - automatically refreshes the raw version when you save a user script page

// requires wikipage.js, cookie.js, addlilink.js

// quarl 2006-01-10 initial version

function userscriptMakeUrl(wp) {
    // note: wp.qurl is parsed from source and is not the same as blindly escaping the input!  String
    // has to exactly match what the user is using, e.g. "User:Quarl/script", not "User%3AQuarl/script"!
    return wp.qurl + '&action=raw&ctype=text/javascript&dontcountme=s';
}

function userscript_load() {
    if (!wikiPage.article.match(/[.]js$/)) return;

    addTab(userscriptMakeUrl(wikiPage), 'raw', 'ca-raw', "Show raw version of user script");
    addTab('javascript:userscript_DoRefresh()', 'refresh', 'ca-refresh', "Force browser to refresh the raw version of this script");

    userscript_refreshIfChanged();
}

// Check if the current script has changed since last time we looked at it;
// if so, refresh.  Use a cookie to check.
function userscript_refreshIfChanged() {
    // if we're not looking at current revision, don't do anything.
    if (permalinkP) return;

    // we don't have the oldid for some reason (e.g. we're currently editing)
    if (!pageOldid) return;

    //var cookie_name = 'usl_oldid_' + wikiPage.pageQuoted;
    var cookie_name = 'usl_oldid';

    // by using a different cookie-path we avoid sending tons of cookies for every page,
    // and we don't have to uniquify the cookie name.  Note that if unspecified, the path
    // is equivalent to "/wiki/User:Quarl/" instead of "/wiki/User:Quarl/foo.js", which is
    // just as bad as "/"
    var path = url_getpath(wikiPage.url); // only bother with canonical URL
    last_oldid = readCookie(cookie_name);
    if (last_oldid != pageOldid) {
        // first time we're looking at the page, or the page has changed. refresh.
        userscript_DoRefresh();
    }
    createCookie(cookie_name, pageOldid, 7, path);
}

function userscript_DoRefresh() {
    force_refresh(userscriptMakeUrl(wikiPage));
}

function force_refresh(url) {
    // We can't do frm.location.reload() right now because frm.location will still be "about:blank", but if we complete this event and start a new one, it works.

    //frm.location.replace(url);
    //frm.location.href = url;
    document.getElementById('userscript_refresher').src = url;
    setTimeout('force_refresh_cont_1()', 0);
}

function force_refresh_cont_1() {
    var frm = window.frames['userscript_refresher'];
    frm.location.reload();

    // status
    document.getElementById('ca-refresh').innerHTML = '<b>refreshed</b>';
}

addOnloadHook(userscript_load);

// hidden iframe
if (false) // debug
document.write('<div style="float:right;" id="hidden_userscript_iframe_div"><iframe src="about:blank" height="80" width="80" name="userscript_refresher" id="userscript_refresher"></iframe></div>');
else
document.write('<div style="position:absolute;left:0px;top:0px;visibility:hidden;" id="hidden_userscript_iframe_div"><iframe src="about:blank" height="0" width="0" name="userscript_refresher" id="userscript_refresher"></iframe></div>');