web access logging to DB

[freeside.git] / FS / FS / access_user_log.pm

diff --git a/FS/FS/access_user_log.pm b/FS/FS/access_user_log.pm
new file mode 100644 (file)
index 0000000..884d250
--- /dev/null
+++ b/FS/FS/access_user_log.pm
@@ -0,0 +1,136 @@
+package FS::access_user_log;
+use base qw( FS::Record );
+
+use strict;
+#use FS::Record qw( qsearch qsearchs );
+use FS::CurrentUser;
+
+=head1 NAME
+
+FS::access_user_log - Object methods for access_user_log records
+
+=head1 SYNOPSIS
+
+  use FS::access_user_log;
+
+  $record = new FS::access_user_log \%hash;
+  $record = new FS::access_user_log { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::access_user_log object represents a backoffice web server log entry.
+  FS::access_user_log inherits from FS::Record.  The following fields are
+currently supported:
+
+=over 4
+
+=item lognum
+
+primary key
+
+=item usernum
+
+usernum
+
+=item path
+
+path
+
+=item _date
+
+_date
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new log entry.  To add the log entry to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'access_user_log'; }
+
+=item insert_new_path PATH
+
+Adds a log entry for PATH for the current user and timestamp.
+
+=cut
+
+sub insert_new_path {
+  my( $class, $path ) = @_;
+
+  my $self = $class->new( {
+    'usernum' => $FS::CurrentUser::CurrentUser->usernum,
+    'path'    => $path,
+    '_date'   => time,
+  } );
+
+  my $error = $self->insert;
+  die $error if $error;
+
+}
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=item delete
+
+Delete this record from the database.
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=item check
+
+Checks all fields to make sure this is a valid log entry.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('lognum')
+    || $self->ut_foreign_key('usernum', 'access_user', 'usernum')
+    || $self->ut_text('path')
+    || $self->ut_number('_date')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>
+
+=cut
+
+1;
+