vos/metaobjects/policy/hostedavatar.cc

Go to the documentation of this file.

/* $Id: hostedavatar.cc,v 1.4 2003/07/23 00:17:30 reed Exp $ */


/** @file hostedAvatar.cc Define HostedAvatar, a MetaObject for "policy:hostedAvatar" object types. */

/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges
 * <reed@zerohour.net> and Peter Amstutz <tetron@interreality.org>.  Search for
 * TODO for stuff that needs editing. You will want to especially fill in
 * constructors, destructors, message handlers, non-property subobjects...
 *
 * The authors of otd2cpp.pl make no guarantee that this code will work, or even
 * that it even is safe to run.  Use it at your own risk.
 */




#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include "hostedavatar.hh"

NoHostedAvatarAccessControl NoHostedAvatarAccessControl::static_;

/* Constructor */
HostedAvatar::HostedAvatar(MetaObject* s) : MetaObject(s)
{
    accessControl = &NoPropertyAccessControl::static_;
}

/* Destructor */
HostedAvatar::~HostedAvatar() {
}

/* Get/Set default AC */
void HostedAvatar::setPropertyAccessControl(PropertyAccessControl* ac) {
    accessControl = ac;
}

PropertyAccessControl* HostedAvatar::getPropertyAccessControl() {
    return accessControl;
}

LocalHostedAvatar::LocalHostedAvatar(MetaObject* s) : HostedAvatar(s), MetaObject(s), hostedavatarAC(0)
{
    addMessageHandler<LocalHostedAvatar>("policy:request-avatar", this, &LocalHostedAvatar::handleRequestAvatar);
    accessControl = &NoPropertyAccessControl::static_;
}

LocalHostedAvatar::~LocalHostedAvatar() {
}

/* Initialize required subobjects: */

void LocalHostedAvatar::initialize(PropertyAccessControl* ac) {
    accessControl = ac;
    initialize();
}

void LocalHostedAvatar::initialize() {

    vRef<LocalSite> localsite = Site::getDefaultPeer();
}

RemoteHostedAvatar::RemoteHostedAvatar(MetaObject* s) : HostedAvatar(s), MetaObject(s)
{
    addUpdateHandler<RemoteHostedAvatar>("policy:request-avatar-reply", this, &RemoteHostedAvatar::handleRequestAvatarReply);

}

RemoteHostedAvatar::~RemoteHostedAvatar() {
}

/* Return type string ("policy:hostedAvatar") */

const string HostedAvatar::getType() {
    return string("policy:hosted-avatar");
}

/* Register extenders with libvos MetaFactory */
void HostedAvatar::registerExtenders() {
    static bool done = false;
    if(! done) {
    LocalSite::addLocalObjectExtension(typeid(LocalHostedAvatar).name(), &LocalHostedAvatar::new_LocalHostedAvatar);
    LocalSite::addLocalObjectExtension(typeid(HostedAvatar).name(), &LocalHostedAvatar::new_LocalHostedAvatar);
    LocalSite::addLocalObjectExtension("policy:hosted-avatar", &LocalHostedAvatar::new_LocalHostedAvatar);
    RemoteSite::addRemoteObjectExtension(typeid(RemoteHostedAvatar).name(), &RemoteHostedAvatar::new_RemoteHostedAvatar);
    RemoteSite::addRemoteObjectExtension(typeid(HostedAvatar).name(), &RemoteHostedAvatar::new_RemoteHostedAvatar);
    RemoteSite::addRemoteObjectExtension("policy:hosted-avatar", &RemoteHostedAvatar::new_RemoteHostedAvatar);
    done = true;
    }
}

/* Get and set Subproperties and other Subobjects */

string HostedAvatar::getHostedAvatarIsRequired() {
    string s;
    vRef<Vobject> v = findObject("policy:hosted-avatar-is-required");
 meta_cast<Property&>(*v).read(s);
    return s;
}

string HostedAvatar::getHostedAvatarIsRequiredDatatype() {
    string s;
    vRef<Vobject> v = findObject("policy:hosted-avatar-is-required");
    s = meta_cast<Property&>(*v).getDataType();
    return s;
}

void HostedAvatar::setHostedAvatarIsRequired(const string& value, const string& datatype, PropertyAccessControl* ac) {
    if(ac == NULL)
        ac = accessControl;
    Property::setProperty(*this, "policy:hosted-avatar-is-required", value, datatype, ac);
}

Vobject* HostedAvatar::getHostedAvatarIsRequiredObject() {
    return &findObject("policy:hosted-avatar-is-required");
}

void HostedAvatar::setHostedAvatarIsRequiredObject(Vobject* newobj) {
    try {
        vRef<ParentChildRelation> pcr = findChild("policy:hosted-avatar-is-required");
        setChild(pcr->position, "policy:hosted-avatar-is-required", newobj);
    } catch (NoSuchObjectError) {
        insertChild(-1, "policy:hosted-avatar-is-required", newobj);
    }
}

/* Local Actuators: */

/* Do request-avatar. */

Vobject& LocalHostedAvatar::doRequestAvatar(Vobject* myavatar) {
    throw AccessControlError("Not implemented");
}

/* Message Handlers:  */

    /* Handle message request-avatar */

void LocalHostedAvatar::handleRequestAvatar(Message* m) {
    /* Fields in this message are:
       myavatar (A vobject supplied by the requester.  This may indicate a requested form for the avatar (how it looks) and where to relay certain types of messages (such as chat messages for Talkative vobjects).) Optional. Default is:
    */

    /* Replies are:
       request-avatar-reply () Fields: path (If the operation was successful, this field contains a rooted path to the avatar that is assigned tothis site.);  error (Only returned if no avatar was created (for access control or other reasons).);
    */

    /* TODO: one way to handle the message is to call the actuator (doRequestAvatar).  To reply to the message, if there is more than one possible reply, you probably want to choose only one... (but it's up to you of course...) */


    try {
        vRef<Message> reply = new Message();
        LocalVobject::initReply(this, &reply, m, "policy:request-avatar-reply");
        vRef<Vobject> from = Vobject::findObjectFromRoot(m->getFrom());
        vRef<Vobject> suppliedavatar;

        try {
            suppliedavatar = Vobject::findObjectFromRoot(m->getField("myavatar").value);
        } catch(Message::NoSuchFieldError){
        } catch(NoSuchObjectError){
        }

        try {
            if(hostedavatarAC) {
                if(hostedavatarAC->checkRequestAvatarPermission(*from, &suppliedavatar)) {
                    vRef<Vobject> v = doRequestAvatar(&suppliedavatar);
                    reply->insertField(-1, "path", v->getURL().getString());
                }
            } else {
                LOG("hostedavatar", 1, "Warning: HostedAvatar vobject " << getURL().getString() << " does not have an access control!  Failing by default");
                throw AccessControlError("This vobject is not initialized properly");
            }
        } catch(AccessControlError e) {
            reply->insertField(-1, "error", e.what());
        }

        from->sendMessage(&reply);
    } catch(Message::NoSuchFieldError e) {
        /* A field wasn't found */
    }

}

/* Remote Actuators: */

/* Do request-avatar. */

Vobject& RemoteHostedAvatar::doRequestAvatar(Vobject* myavatar) {

    /* Create a new message and send it to the local object, and wait for reply.
     * If your message expects no reply, remove the line that calls "waitFor". */

    vRef<Message> m = new Message();
    vRef<LocalSite> ls = RemoteVobject::initFields(this, &m, "policy:request-avatar", true);
    if(myavatar) {
        m->insertField(-1, "myavatar", myavatar->getURL().getString());
    }

    sendMessage(&m);
    vRef<RemoteSite> site = dynamic_cast<RemoteSite&>(getSite());
    vRef<Message> n = ls->waitFor(m->getNonce(), &site);
    try {
        string path = n->getField("path").value;
        Vobject& v = Vobject::findObjectFromRoot(path);
        return v; // pass reference up
    } catch(Message::NoSuchFieldError e) {
        try {
            throw AccessControlError(n->getField("error").value);
        } catch(Message::NoSuchFieldError) {
            throw RemoteError("Didn't get back an expected field");
        }
    } catch(NoSuchObjectError e) {
        throw RemoteError("The object in path field did not exist.");
    } catch(NoSuchSiteError e) {
        throw RemoteError("The object in path field did not exist.");
    } catch(URL::BadURLError e) {
        throw RemoteError("The object path field was maelformed.");
    } catch(...) {
        throw RemoteError("Something bad just happened.");
    }
}

/* Generators for factory */


MetaObject* LocalHostedAvatar::new_LocalHostedAvatar(MetaObject *s, const string& type) {
    LocalHostedAvatar* o = new LocalHostedAvatar(s);
    return o;
}

MetaObject* RemoteHostedAvatar::new_RemoteHostedAvatar(MetaObject *s, const string& type) {
    return new RemoteHostedAvatar(s);
}

/* Handle request-avatar-reply. */

void RemoteHostedAvatar::handleRequestAvatarReply(Message* m) { }

---