root/trunk/hotstuff/ocs/HotstuffOCS.pm

#!/usr/bin/env perl
#
# Open Collaboration Services interface to the Hotstuff database
# Copyright (C) 2009 Josef Spillner <josef@kstuff.org>
# Published under 'GNU AGPLv3 or later' conditions

package HotstuffOCS;

use base qw/CGI::Application/;

use strict;
use warnings;

use CGI::Application::Plugin::Routes;
use XML::Writer;

sub setup {
        my $self = shift;
        $self->routes_root('/:site/v1/content');
        $self->routes([
                '' => 'home' ,
                '/categories'  => 'categories',
                '/data'  => 'list'
        ]);
        $self->start_mode('home');
}

sub database {
        # FIXME: encapsulate and share with hotstuff-stuff
        my $site = shift;

        my $opt_config = "/etc/hotstuff.d/$site.conf";

        use vars qw($dbhost $dbport $dbname $dbuser $dbpass);
        eval{require $opt_config};
        if($@){
                return 0;
        }
        if(!$dbport){
                $dbport = 5432;
        }

        my $conn = DBI->connect("DBI:Pg:host=$dbhost;port=$dbport;dbname=$dbname;user=$dbuser;password=$dbpass");
        # FIXME: Bareword "DBI::errstr" not allowed while "strict subs" in use at HotstuffOCS.pm
        #$conn || die DBI::errstr;
        $conn->{pg_enable_utf8} = 1;
        return $conn;
}

sub list {
        my $self = shift;
        $self->header_add(-content_type => "text/xml");

        # FIXME: categories := 'XxYxZ'
        # FIXME: sortmode := (new|alpha|high|down)

        my $q = $self->query();
        my $site = $q->param('site');
        my $categories = $q->param('categories');
        my $search = $q->param('search');
        my $user = $q->param('user');
        my $sortmode = $q->param('sortmode');
        my $page = $q->param('page');
        my $pagesize = $q->param('pagesize');

        my $conn = database($site);

        my $out;
        my $writer = new XML::Writer(DATA_MODE => 1, OUTPUT => \$out);
        $writer->xmlDecl("UTF-8");
        $writer->startTag("ocs");
        $writer->startTag("meta");
        $writer->dataElement("status", "ok");
        $writer->dataElement("statuscode", "100");
        $writer->dataElement("message", "");
        $writer->dataElement("totalitems", "???");
        $writer->dataElement("itemsperpage", "???");
        $writer->endTag("meta");
        $writer->startTag("data");
        $writer->startTag("content", "details" => "summary");
        $writer->dataElement("id", "???");
        $writer->dataElement("name", "???");
        $writer->dataElement("version", "???");
        $writer->dataElement("changed", "???");
        $writer->dataElement("created", "???");
        $writer->dataElement("typeid", "???");
        $writer->dataElement("typename", "???");
        $writer->dataElement("language", "???");
        $writer->dataElement("personid", "???");
        $writer->dataElement("downloads", "???");
        $writer->dataElement("score", "???");
        $writer->dataElement("comments", "???");
        $writer->dataElement("detailpage", "???");
        $writer->dataElement("preview1", "???");
        $writer->dataElement("previewpic1", "???");
        $writer->endTag("content");
        $writer->endTag("data");
        $writer->endTag("ocs");

        # FIXME: download-type/price/link/name/size

        return $out;
}

sub categories {
        my $self = shift;
        $self->header_add(-content_type => "text/xml");

        my $q = $self->query();
        my $site = $q->param('site');

        my $conn = database($site);

        my $category;
        my @categories = ();

        # FIXME: available repositories could be maintained in a database as well
        my $query = "SELECT DISTINCT category FROM directory";
        my $res = $conn->prepare($query);
        $res->execute();
        $res->bind_columns(\$category);
        while($res->fetch()){
                push @categories, $category;
        }
        $res->finish();

        my $out;
        my $writer = new XML::Writer(DATA_MODE => 1, OUTPUT => \$out);
        $writer->xmlDecl("UTF-8");
        $writer->startTag("ocs");
        $writer->startTag("meta");
        $writer->dataElement("status", "ok");
        $writer->dataElement("statuscode", "100");
        $writer->dataElement("message", "");
        $writer->dataElement("totalitems", "???");
        $writer->endTag("meta");
        $writer->startTag("data");
        foreach my $category(@categories){
                # FIXME: unique ids
                my $id = 0;
                $writer->startTag("category");
                $writer->dataElement("id", $id);
                $writer->dataElement("name", $category);
                $writer->endTag("category");
        }
        $writer->endTag("data");
        $writer->endTag("ocs");

        return $out;
}

sub home {
        my $self = shift;
        $self->header_add(-content_type => "text/plain");

        my $s = "Hotstuff OCS Implementation\n\n";
        $s .= "This script implements the Content part of the Open Collaboration Services (OCS).\n";
        # FIXME: here or rather in hotstuff-provider?
        #$s .= "It also creates the provider meta-information on request.\n";
        $s .= "Please refer to the specification to find out about its methods.\n";

        return $s;
}

1;