Stories
Slash Boxes
Comments
NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

All the Perl that's Practical to Extract and Report

use Perl Log In

Log In

[ Create a new account ]

CPANdeps + Greasemonkey

Journal written by AndyArmstrong (7200) and posted by brian_d_foy on 2007.12.15 12:50   Printer-friendly

I've just written a quick and dirty Greasemonkey script that adds a link to David Cantrell's excellent CPAN dependencies to any CPAN distribution's page on search.cpan.org.

// ==UserScript==
// @name           CPAN Search
// @namespace      http://hexten.net/
// @description    Add links to CPAN
// @include        http://search.cpan.org/
// ==/UserScript==

var new_links = {
    'CPAN Dependencies': function(url, name) {
        return 'http://cpandeps.cantrell.org.uk/?module='
            + escape(make_module_name(name));
    }
};

function canonical_url() {
    var permalink = document.getElementById('permalink');
    if (permalink) {
        return permalink.firstChild.href;
    }
    return '';
}

function trim_url(url) {
    return url.replace(/^http:\/\/[^\/]+\/[^\/]+\//, '').replace(/\/$/, '');
}

function make_module_name(dist_name) {
    return dist_name.replace(/-/, '::');
}

function add_links(nd) {
    var end = nd.lastChild;
    nd.removeChild(end);
    var dist_url  = canonical_url();
    var dist_name = trim_url(dist_url);
    // console.log(dist_name + ' ' + dist_url);
    var keys = [];
    for (var k in new_links) {
        keys.push(k);
    }
    keys = keys.sort();
    for (var l = 0; l < keys.length; l++) {
        nd.appendChild(document.createTextNode(" ]\n[ "));
        var name = keys[l];
        var link = document.createElement('A');
        link.href = new_links[name](dist_url, dist_name);
        link.innerHTML = name;
        nd.appendChild(link);
        // console.log(name + " " + link);

    }
    nd.appendChild(end);
}

var rows = document.getElementsByTagName('tr');
if (rows) {
    for (var r = 0; r < rows.length; r++) {
        var cells = rows[r].getElementsByTagName('td');
        if (cells.length == 2 && cells[0].innerHTML == 'Links') {
            add_links(cells[1].firstChild);
        }
    }
}

I'm sure the DOM walking can be improved - but it works. To add other links add them to the new_links hash. Each entry is the anchor text for the link and a function that returns the URL to link to.

Related Stories

HTTP::Proxy::GreaseMonkey 5 comments [+]
Yesterday I posted a GreaseMonkey script to add a CPAN Dependencies link to search.cpan.org.

The only problem with that is that FireFox is not my main browser. I tend to use FireFox for web development (FireBug++) and Safari for general surfing. Theoretically you can use GreaseMonkey scripts in Safari using CreamMonkey - but I couldn't get that to play nicely with Leopard.

So I've released HTTP::Proxy::GreaseMonkey which builds on BooK's excellent HTTP::Proxy to provide a local proxy that functions like GreaseMonkey.

Version 0.01 of HTTP::Proxy::GreaseMonkey has no support for the GM_* utility functions that the real GreaseMonkey provides - but it works well enough to support my CPAN dependencies user script and probably quite a few other GM scripts. Suggestions are welcome. Suggestions with patches even more so.

Greasemonkeying dependencies [+]

Escalation wars... you just have to love'em.

First, David came up with the über-cool CPAN deps page.

Then Andy comes up with a nifty Greasemonkey script to add it to the CPAN distributions main pages.

Then I add a small patch to the script to retrieve some information from the Deps page.

Then David creates an xml interface to CPAN deps, opening the door wide open for Web 2.0 goodiness.

Then (and this is where we are right now) I hack together a new CPAN_Dependencies monkeyscript to take advantage of said xml interface.

This, of course, is nowhere near the end of the story. My new script only scratches the surface of what can be done with the information contained in the xml. As soon as I have some tuits, I'll probably add a way to toggle between showing only the first-level dependencies and all dependencies, and have dependencies color-coded by degree of b0rkage, and whatever bell or whistle I can think of in the meantime.

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.
  • // @include http://search.cpan.org/* [cpan.org]

    The asterisk is important :)

  • Me likes!

    And don't forget to add it on Userscripts.org [userscripts.org].
  • I prefer using XPath expressions when I can, for much the same reason that I prefer using regular expressions to building my own pastern matching code. To get the same results as your DOM code I would use the following.

    var result = document.evaluate(
        '//tr[td[last()=2]][td[1]/text()="Links"]/td[2]',
        document,
        null,
        XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
        null
    );
    for (var i = 0; i < result.snapshotLength; i++) {
        add_links(result.

    • I think that using it in a userscript is safe though.

      Yes, it’s Firefox (and maybe Opera) only, which supports XPath.

      so I would not use it in general purpose code

      Indeed; in general purpose code you would use jQuery (or some other DOM query library of your preference) to write the same thing with CSS3 selectors. This particular case is not as concise as the XPath version because it needs to check text content, which CSS largely has no means to do.

      For comparison’s sake, if written in jQu

      • Woops. Replace the remaining $() calls with jQuery(). I haven’t trained myself out of the habit completely yet.

    • Thanks for that - much tidier. I'm playing with HTTP::Proxy - in fact working on HTTP::Proxy::GreaseMonkey at the moment so I think I'll leave my version the same until I find out whether Safari does XPath. I'm guessing it doesn't. The current script is now working in Safari for me :)
  • I've tacked the following at the end of your userscript:

    var deps = document.evaluate(
        "//a[contains(text(),'CPAN Dependencies')]",
        document, null, XPathResult.UNORDERED_NODE_SNAPSHOT_TYPE, null );

    if ( deps.snapshotLength > 0 ) {
       GM_xmlhttpRequest({
            method: "GET",
            url: deps.snapshotItem(0).href,
            onload: function ( resp ) { mashupDeps( resp, deps ) }
        });
    }

    function mashupDe

    • Heh :) Now I need to implement GM_xmlhttpRequest in HTTP::Proxy::GreaseMonkey so it works in Safari too...
      • Oh my. On one hand, it should not be impossible, as it's all Javascript and one only has to dig in GreaseMonkey's code to find what's needed. On the other hand, I just peeked at the said GM code, and it's a pretty substancial amount of code. Something tells me it's going to be quiiiite an interesting feature to implement. Good thing that the Christmas vacations and insane quantities of eggnog are just around the corner... :-)

        • I've just released 0.03 which supports GM_xmlhttpRequest and runs your modified version of the script on Safari and FireFox. And to think Aristotle said it couldn't be done :)
          • Doing the impossible. Within 12 hours of the challenge's inception.

            Whoa. Your script-fu *is* strong. 8-o
    • Your wish is my command [cantrell.org.uk]. But if the XML interface starts getting hammered then I might either rate-limit it, or remove it, or change the interface, or paint it purple, or ...
      • Your wish is my command.

        Oooh... Very cool... Thanks!

        *hack* *hack* *tinker* *hack*

        Here! What do you think of this: CPAN_Dependencies [userscripts.org]?

        • Very cool :)
          • Thanks. I must say I'm having a lot of fun tinkering with what is, basically, the CPAN edition of "Pimp My Ride". :-)
        • It doesn't want to install for me (or possibly I just don't know how to install it), so I have no idea :-) but if there's anything I can do to the XML to make it work better for you, please let me know. And I'll add a link to the script from my site shortly.
          • It doesn't want to install for me (or possibly I just don't know how to install it)

            Drat! Hmm... Silly question, but, you do have Greasemonkey installed, right?

            if there's anything I can do to the XML to make it work better for you, please let me know.

            Thanks! I'll remember that. :-)

            I'll add a link to the script from my site shortly.

            Excellent. Fame, here I come!

            • you do have Greasemonkey installed, right?
              Errm, no. I thought it was part of Firefox.
              • Heh. Good thing I remembered the golden rule of debugging: "first, always check if it's plugged in". ;-)

                But yes, if you want the script to work, you have to install GreaseMonkey, or use the cool proxy that Andy came up with (http://search.cpan.org/~andya/HTTP-Proxy-GreaseMonkey-0.05)
    • Looks like Graham's done the ultimate escalation and added a link to cpandeps to all the distribution pages. Unfortunately, the machine it's on at the moment can't handle the traffic. Newer, studlier, stronger, faster, better server coming soon.