Revision [2710]

This is an old revision of IncludeRemote made by DarTar on 2004-12-01 08:14:52.

 

Fetching Remote Wikka Content

Last edited by DarTar:
FetchRemote action v.0.3
Wed, 01 Dec 2004 08:14 UTC [diff]


An interesting solution for making freshly-updated HelpInfo wikka documentation available to end users, without distributing the whole documentation package, might be to create a {{fetchremote page="PageName"}} plugin allowing to retrieve content from the main wikka server, using something like the raw method.


The idea


Here's how it might function:
  1. the user of a wikka distribution opens a local WikkaDocumentation page containing {{fetchremote page="HelpInfo"}};
  1. the plugin connects to the main wikka server,
  1. it fetches a raw version of HelpInfo with no header and footer (i.e. the mere page content in wikka syntax),
  1. it parses the fetched page for internal links and translates them into local links to fetchable pages (links pointing to remote URLs need not be translated),
  1. and finally, it prints locally the documentation contents.
  1. if a connection is not available, a splash page with a static link to http://wikka.jsnx.com/HelpInfo and a short text is printed;

A similar plugin might be used also for bug notifications and other kinds of "centralized" content.

Notes:
    1. the fetched content integrates seamlessly with the layout and structure of the Wikka-client;
    1. the user can choose to download locally a fetched page, so as to make it available in its Wikka site.


Screenshot:
http://wikka.jsnx.com/images/fetchremote.jpg


Now, here comes some code.

FetchRemote: a plugin for fetching remote documentation


FetchRemote Action
Version 0.3

What it does

How to use it
Simply add {{fetchremote}} in one of your pages.
You can specify a starting page by adding: {{fetchremote page="HomePage"}}

Note
Remote fetching of pages through fopen() must be allowed by php (by default it is).

Todo:

Here's a three-step installation:

1. Create on the target server a rawcontent handler (handlers/page/rawcontent.php)

<?php
if ($this->HasAccess("read")) {
    if (!$this->page) {
        return;
    } else {
        // display raw page
        print($this->page["body"]);
    }
} else {
    return;
}
?>


2. Update wikka.php on the target server

The following blocks of code must be modified to enable the rawcontent handler:

A)

original
    if (preg_match('/\.(xml|mm)$/', $this->method)) {
        header("Content-type: text/xml");
        print($this->Method($this->method));
    }


modified
    if (preg_match('/\.(xml|mm)$/', $this->method)) {
        header("Content-type: text/xml");
        print($this->Method($this->method));
    }
    // rawcontent method
    elseif ($this->method == "rawcontent"){
        header("Content-type: text/plain");
        print($this->Method($this->method));
    }


B)

original
// if (!preg_match("/\.(xml|raw|mm)$/", $method))
{
    $tend = getmicrotime();  
    //Calculate the difference
    $totaltime = ($tend - $tstart);
    //Output result
    printf ("<div class=\"smallprint\">Page was generated in %.4f seconds</div>\n</body>\n</html>", $totaltime);
}  


modified
if (!preg_match("/(xml|raw|mm|rawcontent)$/", $method))
{
    $tend = getmicrotime();  
    //Calculate the difference
    $totaltime = ($tend - $tstart);
    //Output result
    printf ("<div class=\"smallprint\">Page was generated in %.4f seconds</div>\n</body>\n</html>", $totaltime);
}


3. Create in the Wikka client a FetchRemote action (actions/fetchremote.php)

<?php
// FetchRemote Action
// Written by DarTar <http://wikka.jsnx.com/DarTar>
// Version 0.3
//
// * Connects to the main Wikka server and fetches Wikka Documentation Pages
// (a "rawcontent" method must be available on the main Wikka server, in order to produce
// raw wikka-formatted content with header and footer stripped).
// * Displays an error message if remote pages do not exist on the server or if a connection is not available
// * Parses the fetched page and rewrites links as links to fetchable pages
// * Prints the fetched page locally, together with a header
// * Allows fetched pages to be safely stored on the Wikka client
//
// Parameters: page - specifies starting page on the remote server


// Set remote Wikka server root
$remote_server_root = "http://wikka.jsnx.com/";
// debugging
// $remote_server_root="http://test/wikka-1.1.5.0/wikka.php?wakka=";

//set default remote page if no page parameter or GET value is specified
$page = $_REQUEST["page"]? $_REQUEST["page"] : $page;
if ($page == "") $page = "HelpInfo";

// redirect to home on disconnection
if ($_POST["action"] == "Disconnect") $this->Redirect($this->GetConfigValue("root_page"));

// open connection
$remote_page = fopen($remote_server_root.$page."/rawcontent", "r");
if (!$remote_page) {
    // connection failed: print static link
    echo $this->Format("=====Wikka Documentation===== --- Visit the **[[http://wikka.jsnx.com/HelpInfo Wikka Documentation Project]]** --- --- ");
} else {
    // connection established: start fetching remote page

    // build header
    $style = "text-align: center; margin: 30px 25%; border: 1px dotted #333; background-color: #EEE; padding: 5px;";

    if ($_POST["action"] == "Download this page") {
        if ($this->LoadPage($page)) {
            // display error message: local page with the same name already exists
            $header = "@@Sorry, a page named **[[".$page."]]** already exists on this site!@@ --- ";
        } else {
            // write page to database and display message
            $note = "fetched from the Wikka server";
            $this->SavePage($page, $content, $note);
            $header = "@@**[[".$page."]]** is now available on your site!@@ --- ";
        }
        $form = $this->FormOpen()."<input type='submit' name='action' value='Return to Wikka Documentation' /><input type='submit' name='action' value='Disconnect' />".$this->FormClose();
    } else {
        $header = "You are currently browsing: **";
        $header .=  "\"\"<a href='".$this->Href("","","page=".$page)."'>".$page."</a>\"\"";
        $header .= "** --- from the **[[".$this->GetPageTag()." Wikka Documentation Project]]** --- (fetched from the [[".$remote_server_root.$page." Wikka server]])";
        $form = $this->FormOpen()."<input type='hidden' name='page' value='".$page."' /><input type='submit' name='action' value='Download this page' /><input type='submit' name='action' value='Disconnect' />".$this->FormClose();
    }

    // fetch rawcontent of remote page
    while (!feof($remote_page)) {
        $content .= fgets($remote_page, 1024);
    }

    if (!$content) {
        // missing page: show error message
        $header = "Sorry, **";
            $header .=  "\"\"<a href='".$this->Href("","","page=".$page)."'>".$page."</a>\"\"";
            $header .= "** cannot be found on the [[".$remote_server_root.$page." Wikka server]]! --- Return to the **[[".$this->GetPageTag()." Wikka Documentation Project]]** --- ";
        $form = "";
    }

    // regex pattern for forced links to internal pages
    $forced = "/\[\[([^ \/]+) ([^\]]+)\]\]/";
    // regex pattern for CamelCase links
    $camel = "/[^a-z=>\[\/]([A-Z]+[a-z]+[A-Z][A-Za-z0-9]+)+/";

    // rewrite forced links
    $content = preg_replace($forced, "\"\"<a href='".$this->Href("","","page=\\1")."'>\\2</a>\"\"", $content);

    // rewrite camelcase links
    $content = preg_replace($camel, "\"\" <a href='".$this->Href("","","page=\\1")."'>\\1</a>\"\"", $content);

    // print rewritten content 
    print "<div style='".$style."'>".$this->Format($header).$form."</div>".$this->Format($content);

}
fclose($remote_page);
?>


<?php
// LINK REWRITING PLAYGROUND

/*
    echo $this->Format("=====Link Translation Test===== --- --- (Source: ".$remote_server_root.$page.") --- --- ");

    if (preg_match_all($forced, $content, $forcedlinks)) {
        echo $this->Format("==Forced links:==");
        foreach ($forcedlinks[0] as $fkey => $fitem) {
            $ftag = $forcedlinks[1][$fkey];
            $fanchor = $forcedlinks[2][$fkey];
            // display link and rewritten link
            echo $this->Format($fkey.": ".$fitem." => ")."<a href='".$this->Href("","","page=".$ftag)."'>".$fanchor."</a><br />";
            // add rewritten link to array 
            $fsearch[$fkey] = $fitem;  
            $freplace[$fkey] = "\"\"<a href='".$this->Href("","","page=".$ftag)."'>".$fanchor."</a>\"\"";
        }
        // rewrite forced links
        //$content = preg_replace($fsearch, $freplace, $content);
    }

       if (preg_match_all($camel, $content, $camellinks)) {
        echo $this->Format(" --- ==Camelcase links:==");
        foreach ($camellinks[0] as $ckey => $citem) {
                        $citem = ltrim($citem);
            echo $this->Format($ckey.": ".$citem." => ")."<a href='".$this->Href("","","page=".$citem)."'>".$citem."</a><br />";
            $csearch[$ckey] = $citem;
            $creplace[$ckey] = " \"\"<a href='".$this->Href("","","page=".$citem)."'>".$citem."</a>\"\"";
                }
        // rewrite CamelCase links
        //$content = preg_replace($csearch, $creplace, $content);
        }

*/



?>



-- DarTar


CategoryDevelopment
There are 17 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki