Changeset 1992

Timestamp:

04/27/17 00:47:36 (7 years ago)

Author:

nanardon

Message:

Allow sub-object creation when creating object

Location:

trunk/LATMOS-Accounts

Files:

• Changes (modified) (1 diff)
• lib/LATMOS/Accounts/Bases.pm (modified) (4 diffs)
• lib/LATMOS/Accounts/Bases/Objects.pm (modified) (1 diff)
• lib/LATMOS/Accounts/Bases/Sql/User.pm (modified) (1 diff)
• man/man8/latmos-accounts.pod (modified) (1 diff)

trunk/LATMOS-Accounts/Changes

@@ +1 @@
+5.2.15
+    When creating object related object can be directly
+      created at the same time (man latmos-accounts: "INPUT FILE" section)
+    Improve code to suggest collision avoidance login at user creation
+
 5.2.14
 

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases.pm

@@ -7 +7 @@
 use LATMOS::Accounts::Bases::Attributes;
 use LATMOS::Accounts::Log;
-use LATMOS::Accounts::Utils qw(exec_command to_ascii);
+use LATMOS::Accounts::Utils qw(exec_command to_ascii );
 
 our $VERSION = (q$Rev$ =~ /^Rev: (\d+) /)[0];
@@ -195 +195 @@
     return @sobj;
 }
+
+=head2 ListSubObjectOType($otype)
+
+Return a list of sub object type supported by C<otype> objects.
+
+=cut
+
+sub ListSubObjectOType {
+    my ($self, $otype) = @_;
+
+    # finding perl class:
+    my $pclass = $self->_load_obj_class($otype) or return;
+    my $definition = "$pclass"->GetOtypeDef($self) or return;
+
+    return keys %{ $definition || {} }
+}
+
+=head2 GetSubObjectKey($otype, $sotype)
+
+Return the key linking sub object C<$sotype> to object type C<$otype>
+
+=cut
+
+sub GetSubObjectKey {
+    my ($self, $otype, $sotype) = @_;
+
+    # finding perl class:
+    my $pclass = $self->_load_obj_class($otype) or return;
+    my $definition = "$pclass"->GetOtypeDef($self, $sotype) or return;
+
+    return $definition->{$sotype};
+}
+
 
 =head2 ordered_objects
@@ -376 +409 @@
 
     my %data;
+    my $sub;
     foreach my $cfield (keys %cdata) {
-        my $attribute = $self->attribute($otype, $cfield) or next;
-        $attribute->ro and next;
-        $data{$cfield} = $cdata{$cfield};
-    }
+        # Parsing subobject creation:
+
+        if (my ($sotype, $key, $scfield) = $cfield =~ /^(\w+)(?:\[(\w+)\])?\.(.*)/) {
+            $key ||= '_';
+            $sub->{$sotype}{$key}{$scfield} = $cdata{$cfield};
+        } else {
+            my $attribute = $self->attribute($otype, $cfield) or next;
+            $attribute->ro and next;
+            $data{$cfield} = $cdata{$cfield};
+        }
+    }
+
     $self->create_object($otype, $id, %data) or return;
     my $obj = $self->get_object($otype, $id) or return;
@@ -393 +435 @@
                 ? join(', ', @{ $data{$attrname} })
                 : $data{$attrname}) || '(none)');
+    }
+
+    if ($sub) {
+
+        # Security: if caller is create_c_object calling it to check permission ?
+        # See below
+        # my ($caller) = caller();
+        # my $subcreate = $caller eq 'create_c_object' ? 'create_c_object' : __SUB__;
+        
+        # Trying to create subobject
+        foreach my $sotype (keys %$sub) {
+            my $SubKeyRef = $self->GetSubObjectKey($otype, $sotype) or do {
+                $self->log(LA_ERR, "Cannot create object type $sotype, subtype of $otype not defined");
+                return;
+            };
+            foreach my $skey (keys %{ $sub->{$sotype} || {} }) {
+                # Building id
+                my $info = $sub->{$sotype}{$skey} || {};
+                # For id: if key is given using it, otherwise using random
+                my $sid = 
+                    $info->{$SubKeyRef} ||
+                    $id . '-' . join('', map { ('a' .. 'z')[rand(26)] } (0 .. 6));
+                $info->{$SubKeyRef} = $id;
+
+                # Here we don't check permission to create sub object:
+                $self->_create_c_object($sotype, $sid, %{ $info || {} }) or return;
+            }
+        }
     }
 

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm

@@ -197 +197 @@
     @attrs = grep { $_->readable } @attrs if($for =~ /r/);
     map { $_->name } grep { !$_->hidden }  @attrs;
+}
+
+=head2 GetOtypeDef
+
+This function is called to provide sub object definition. Must be overwritten
+per object class when need.
+
+Must return a hashref listing each sub object type and their related key atribute:
+
+    return {
+        addresses => 'user',
+    }
+
+=cut
+
+sub GetOtypeDef {
+    my ($class) = @_;
+
+    return;
 }
 

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql/User.pm

@@ -58 +58 @@
     || $self->get_field('description')
     || $self->id;
+}
+
+sub GetOtypeDef {
+    my ($class) = @_;
+
+    {
+        address => 'user',
+        employment => 'user',
+    },
 }
 

trunk/LATMOS-Accounts/man/man8/latmos-accounts.pod

@@ -139 +139 @@
 =back
 
+=head1 INPUT FILE
+
+The input file is a list of attribute and value separate by a semi-colon.
+Multi-values attributes must be repeated for each value.
+Attributes not listed are left untouched.
+
+Example:
+
+    sn: Myname
+    givenName: Myfirstname
+
+Some object have related objects, for example C<user> have multiple C<address>
+and C<employment>. It can be usefull to create those object in same time the
+main object.
+
+At creation the related object attributes can given using attribute in form
+C<OTYPE.ATTRIBUTE>.
+
+Example:
+
+    sn: Myname
+    givenName: Myfirstname
+    address.streetAddress: 5th Avenue, 123
+
+Multiple objects of same type can be given a key between C<[]>, this key may
+use any letter C<a-z>, C<A-Z> or number C<0-9>.
+
+    sn: Myname
+    givenName: Myfirstname
+    address[0].streetAddress: 5th Avenue, 123
+    address[aa].streetAddress: 5th Avenue, 123
+
 =head1 TOOLS LIST