Changeset 1023 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql.pm

Timestamp:

05/29/12 10:25:51 (12 years ago)

Author:

nanardon

Message:

• complete POD

This patch a basic documentation to all functions.
It also add two test to ensure all POD syntax are correct and coverage is full.

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql.pm (modified) (21 diffs)

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

@@ -60 +60 @@
     $self->{_db} && $self->{_db}->rollback;
 }
+
+=head2 db
+
+Return a L<DBI> handle over database, load it if need.
+
+=cut
 
 sub db {
@@ -84 +90 @@
         $self->{_db}->do(q{set DATESTYLE to 'DMY'});
         $self->log(LA_DEBUG, 'New connection to DB');
+        $self->{_db}->commit;
         return $self->{_db};
     }
@@ -153 +160 @@
 } 
 
-
-# Extra non standard functions
+=head1 SPECIFICS FUNCTIONS
+
+=head2 get_global_value ($varname)
+
+Return global value set into base
+
+=cut
 
 sub get_global_value {
@@ -167 +179 @@
     $res->{val}
 }
+
+=head2 set_global_value ($varname, $value)
+
+Set global value.
+
+=cut
 
 sub set_global_value {
@@ -181 +199 @@
 }
 
+=head2 generate_rsa_key ($password)
+
+Return public and private peer rsa keys
+
+=cut
+
 sub generate_rsa_key {
     my ($self, $password) = @_;
@@ -195 +219 @@
 }
 
+=head2 private_key ($password)
+
+Load and return private rsa key
+
+=cut
+
 sub private_key {
     my ($self, $password) = @_;
@@ -204 +234 @@
     $privkey
 }
+
+=head2 get_rsa_password
+
+Return hash with peer username => encryptedPassword
+
+=cut
 
 sub get_rsa_password {
@@ -221 +257 @@
 }
 
+=head2 store_rsa_key ($public, $private)
+
+Store public and private RSA key info data base
+
+=cut
+
 sub store_rsa_key {
     my ($self, $public, $private) = @_;
@@ -231 +273 @@
 }
 
+=head2 find_next_expire_users ($expire)
+
+Search user expiring in C<$expire> delay
+
+=cut
 
 sub find_next_expire_users {
@@ -252 +299 @@
 }
 
+=head2 find_expired_users ($expire)
+
+Return list of user going to expires in C<$expire> delay
+
+=cut
+
 sub find_expired_users {
     my ($self, $expire) = @_;
@@ -271 +324 @@
 }
 
+=head2 rename_nethost ($nethostname, $to, %options)
+
+Facility function to rename computer to new name
+
+=cut
+
 sub rename_nethost {
     my ($self, $nethostname, $to, %options) = @_;
@@ -287 +346 @@
     return 1;
 }
+
+=head2 nethost_exchange_ip ($ip1, $ip2)
+
+Exchange ip1 with ip2 in base
+
+=cut
 
 sub nethost_exchange_ip {
@@ -316 +381 @@
 }
 
+=head1 ATTRIBUTES FUNCTIONS
+
+=head2 register_attribute ($otype, $attribute, $comment)
+
+Register a new attribute in base
+
+=cut
+
 sub register_attribute {
     my ($self, $otype, $attribute, $comment) = @_;
@@ -322 +395 @@
 }
 
+=head2 is_registered_attribute ($otype, $attribute)
+
+Return true is attribute already exists
+
+=cut
+
 sub is_registered_attribute {
     my ($self, $otype, $attribute) = @_;
@@ -328 +407 @@
 }
 
+=head2 get_attribute_comment ($otype, $attribute)
+
+Return the comment associated to attribute
+
+=cut
+
 sub get_attribute_comment {
     my ($self, $otype, $attribute) = @_;
@@ -334 +419 @@
 }
 
+=head2 set_attribute_comment ($otype, $attribute, $comment)
+
+Set comment to attribute
+
+=cut
+
 sub set_attribute_comment {
     my ($self, $otype, $attribute, $comment) = @_;
@@ -340 +431 @@
 }
 
-sub check_user_manager {
+sub _check_user_manager {
     $_[0]->_handle_by_unexported('user', 'manager', 'active');
 }
 
-sub check_group_manager {
+sub _check_group_manager {
     $_[0]->_handle_by_unexported('group', 'managedBy');
 }
 
-sub check_nethost_owner {
+sub _check_nethost_owner {
     $_[0]->_handle_by_unexported('nethost', 'owner', 'active');
 }
@@ -372 +463 @@
 }
 
+=head2 get_datarequest ($id)
+
+Return user request C<$id>
+
+=cut
+
 sub get_datarequest {
     my ($self, $id) = @_;
@@ -388 +485 @@
 }
 
+=head2 list_requests
+
+List user request currently waiting in base
+
+=cut
+
 sub list_requests {
     my ($self) = @_;
@@ -404 +507 @@
     @ids
 }
+
+=head2 list_pending_requests
+
+List user request to apply
+
+=cut
 
 sub list_pending_requests {
@@ -422 +531 @@
     @ids
 }
+
+=head2 list_auto_pending_requests
+
+List automatic request
+
+=cut
 
 sub list_auto_pending_requests {