JezK
Edit File: Object.pm
# -*- perl -*- # # Copyright (C) 2004-2011 Daniel P. Berrange # # This program is free software; You can redistribute it and/or modify # it under the same terms as Perl itself. Either: # # a) the GNU General Public License as published by the Free # Software Foundation; either version 2, or (at your option) any # later version, # # or # # b) the "Artistic License" # # The file "COPYING" distributed along with this file provides full # details of the terms and conditions of the two licenses. =pod =head1 NAME Net::DBus::Object - Implement objects to export to the bus =head1 SYNOPSIS # Connecting an object to the bus, under a service package main; use Net::DBus; # Attach to the bus my $bus = Net::DBus->find; # Acquire a service 'org.demo.Hello' my $service = $bus->export_service("org.demo.Hello"); # Export our object within the service my $object = Demo::HelloWorld->new($service); ....rest of program... # Define a new package for the object we're going # to export package Demo::HelloWorld; # Specify the main interface provided by our object use Net::DBus::Exporter qw(org.example.demo.Greeter); # We're going to be a DBus object use base qw(Net::DBus::Object); # Export a 'Greeting' signal taking a stringl string parameter dbus_signal("Greeting", ["string"]); # Export 'Hello' as a method accepting a single string # parameter, and returning a single string value dbus_method("Hello", ["string"], ["string"]); sub new { my $class = shift; my $service = shift; my $self = $class->SUPER::new($service, "/org/demo/HelloWorld"); bless $self, $class; return $self; } sub Hello { my $self = shift; my $name = shift; $self->emit_signal("Greeting", "Hello $name"); return "Said hello to $name"; } # Export 'Goodbye' as a method accepting a single string # parameter, and returning a single string, but put it # in the 'org.exaple.demo.Farewell' interface dbus_method("Goodbye", ["string"], ["string"], "org.example.demo.Farewell"); sub Goodbye { my $self = shift; my $name = shift; $self->emit_signal("Greeting", "Goodbye $name"); return "Said goodbye to $name"; } =head1 DESCRIPTION This the base for implementing objects which are directly exported to the bus. The methods implemented in a subclass are mapped to methods on the bus. By using this class, an application is directly tieing the RPC functionality into its object model. Applications may thus prefer to use the C<Net::DBus::ProxyObject> class which allows the RPC functionality to be maintained separately from the core object model, by proxying RPC method calls. =head1 METHODS =over 4 =cut package Net::DBus::Object; use 5.006; use strict; use warnings; use base qw(Net::DBus::BaseObject); =item my $object = Net::DBus::Object->new($service, $path) This creates a new DBus object with an path of C<$path> registered within the service C<$service>. The C<$path> parameter should be a string complying with the usual DBus requirements for object paths, while the C<$service> parameter should be an instance of L<Net::DBus::Service>. The latter is typically obtained by calling the C<export_service> method on the L<Net::DBus> object. =item my $object = Net::DBus::Object->new($parentobj, $subpath) This creates a new DBus child object with an path of C<$subpath> relative to its parent C<$parentobj>. The C<$subpath> parameter should be a string complying with the usual DBus requirements for object paths, while the C<$parentobj> parameter should be an instance of L<Net::DBus::BaseObject> or a subclass. =cut sub new { my $class = shift; my $self = $class->SUPER::new(@_); bless $self, $class; return $self; } sub _dispatch_object { my $self = shift; my $connection = shift; my $message = shift; my $reply; my $method_name = $message->get_member; my $interface = $message->get_interface; if ($self->_is_method_allowed($method_name)) { my $ins = $self->_introspector; my @ret = eval { my @args; if ($ins) { if (defined $interface and not $ins->has_interface($interface)) { die Net::DBus::Error->new(name => 'org.freedesktop.DBus.Error.UnknownMethod', message => "object does not provide interface '$interface'"); } @args = $ins->decode($message, "methods", $method_name, "params"); ($interface) = $ins->has_method($method_name) unless defined $interface; if (defined $interface && scalar @args != scalar $ins->get_method_params($interface, $method_name)) { die Net::DBus::Error->new(name => 'org.freedesktop.DBus.Error.Failed', message => "incorrect number of parameters for method '$method_name' in interface '$interface'"); } } else { @args = $message->get_args_list; } $self->$method_name(@args); }; if ($@) { if (defined($interface) && $ins && $ins->method_has_strict_exceptions($method_name, $interface) && !UNIVERSAL::isa($@, "Net::DBus::Error")) { die($@); } my $name = UNIVERSAL::isa($@, "Net::DBus::Error") ? $@->name : "org.freedesktop.DBus.Error.Failed"; my $desc = UNIVERSAL::isa($@, "Net::DBus::Error") ? $@->message : $@; $reply = $connection->make_error_message($message, $name, $desc); } else { $reply = $connection->make_method_return_message($message); if ($ins) { $self->_introspector->encode($reply, "methods", $method_name, "returns", @ret); } else { $reply->append_args_list(@ret); } } } return $reply; } sub _dispatch_property { my $self = shift; my $name = shift; if (!$self->can($name)) { die "no method to for property '$name'"; } return $self->$name(@_); } sub _is_method_allowed { my $self = shift; my $method = shift; # Disallow any method defined in this specific package, since these # are all server-side helpers / internal methods return 0 if __PACKAGE__->can($method); # If this object instance doesn't have it defined, trivially can't # allow it return 0 unless $self->can($method); my $ins = $self->_introspector; if (defined $ins) { # Finally do check against introspection data return $ins->is_method_allowed($method); } # No introspector, so have to assume its allowed return 1; } 1; =pod =back =head1 AUTHOR Daniel P. Berrange =head1 COPYRIGHT Copyright (C) 2005-2011 Daniel P. Berrange =head1 SEE ALSO L<Net::DBus>, L<Net::DBus::Service>, L<Net::DBus::BaseObject>, L<Net::DBus::ProxyObject>, L<Net::DBus::Exporter>, L<Net::DBus::RemoteObject> =cut