4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs dbdef );
6 use FS::UID qw( dbh driver_name );
12 FS::log - Object methods for log records
18 $record = new FS::log \%hash;
19 $record = new FS::log { 'column' => 'value' };
21 $error = $record->insert;
23 $error = $new_record->replace($old_record);
25 $error = $record->delete;
27 $error = $record->check;
31 An FS::log object represents a log entry. FS::log inherits from
32 FS::Record. The following fields are currently supported:
36 =item lognum - primary key
38 =item _date - Unix timestamp
40 =item agentnum - L<FS::agent> to which the log pertains. If it involves a
41 specific customer, package, service, invoice, or other agent-specific object,
42 this will be set to that agentnum.
44 =item tablename - table name to which the log pertains, if any.
46 =item tablenum - foreign key to that table.
48 =item level - log level: 'debug', 'info', 'notice', 'warning', 'error',
49 'critical', 'alert', 'emergency'.
51 =item message - contents of the log entry
61 Creates a new log entry. Use FS::Log instead of calling this directly,
68 =item insert [ CONTEXT... ]
70 Adds this record to the database. If there is an error, returns the error,
71 otherwise returns false.
73 CONTEXT may be a list of context tags to attach to this record.
75 Will send emails according to the conditions in L<FS::log_email>.
80 # not using process_o2m for this, because we don't have a web interface
82 my $error = $self->SUPER::insert;
83 return $error if $error;
84 my $contexts = {}; #for quick checks when sending emails
86 my $context = FS::log_context->new({
87 'lognum' => $self->lognum,
90 $error = $context->insert;
91 return $error if $error;
94 foreach my $log_email (
100 'value' => $self->level,
105 # shouldn't be a lot of these, so not packing this into the qsearch
106 next if $log_email->context && !$contexts->{$log_email->context};
107 my $msg_template = qsearchs('msg_template',{ 'msgnum' => $log_email->msgnum });
108 unless ($msg_template) {
109 warn "Could not send email when logging, could not load message template for logemailnum " . $log_email->logemailnum;
112 my $emailerror = $msg_template->send(
113 'to' => $log_email->to_addr,
115 'loglevel' => $FS::Log::LEVELS[$self->level], # which has hopefully been loaded...
116 'logcontext' => $log_email->context, # use the one that triggered the email
117 'logmessage' => $self->message,
120 warn "Could not send email when logging: $emailerror" if $emailerror;
125 # these methods can be inherited from FS::Record
127 sub delete { die "Log entries can't be modified." };
129 sub replace { die "Log entries can't be modified." };
133 Checks all fields to make sure this is a valid example. If there is
134 an error, returns the error, otherwise returns false. Called by the insert
143 $self->ut_numbern('lognum')
144 || $self->ut_number('_date')
145 || $self->ut_numbern('agentnum')
146 || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
147 || $self->ut_textn('tablename')
148 || $self->ut_numbern('tablenum')
149 || $self->ut_number('level')
150 || $self->ut_text('message')
152 return $error if $error;
154 if ( my $tablename = $self->tablename ) {
155 my $dbdef_table = dbdef->table($tablename)
156 or return "tablename '$tablename' does not exist";
157 $error = $self->ut_foreign_key('tablenum',
159 $dbdef_table->primary_key);
160 return $error if $error;
168 Returns the context for this log entry, as an array, from least to most
175 map { $_->context } qsearch({
176 table => 'log_context',
177 hashref => { lognum => $self->lognum },
178 order_by => 'ORDER BY logcontextnum ASC',
190 Returns a qsearch hash expression to search for parameters specified in
191 HASHREF. Valid parameters are:
197 =item date - arrayref of start and end date
199 =item level - either a specific level, or an arrayref of min and max level
201 =item context - a context string that the log entry must have. This may
202 change in the future to allow searching for combinations of context strings.
204 =item object - any database object, to find log entries related to it.
206 =item tablename, tablenum - alternate way of specifying 'object'.
208 =item custnum - a customer number, to find log entries related to the customer
209 or any of their subordinate objects (invoices, packages, etc.).
211 =item message - a text string to search in messages. The search will be
212 a case-insensitive LIKE with % appended at both ends.
218 # used for custnum search: all tables with custnums
221 sub _setup_table_stubs {
247 my $pkey = dbdef->table($table)->primary_key;
249 "log.tablename = '$table' AND ".
250 "EXISTS(SELECT 1 FROM $table WHERE log.tablenum = $table.$pkey AND ".
251 "$table.custnum = "; # needs a closing )
255 "(log.tablename LIKE 'svc_%' OR log.tablename = 'cust_svc') AND ".
256 "EXISTS(SELECT 1 FROM cust_svc JOIN cust_pkg USING (svcnum) WHERE ".
257 "cust_pkg.custnum = "; # needs a closing )
261 my ($class, $params) = @_;
268 if ( $params->{'agentnum'} =~ /^(\d+)$/ ) {
277 if ( $params->{'custnum'} =~ /^(\d+)$/ ) {
278 _setup_table_stubs() unless @table_stubs;
280 my @orwhere = map { "( $_ $custnum) )" } @table_stubs;
281 push @where, join(' OR ', @orwhere);
288 if ( ref $params->{'level'} eq 'ARRAY' ) {
289 my ($min, $max) = @{ $params->{'level'} };
290 if ( $min =~ /^\d+$/ ) {
291 push @where, "log.level >= $min";
293 if ( $max =~ /^\d+$/ ) {
294 push @where, "log.level <= $max";
296 } elsif ( $params->{'level'} =~ /^(\d+)$/ ) {
297 push @where, "log.level = $1";
304 if ( ref $params->{'date'} eq 'ARRAY' ) {
305 my ($beg, $end) = @{ $params->{'date'} };
306 if ( $beg =~ /^\d+$/ ) {
307 push @where, "log._date >= $beg";
309 if ( $end =~ /^\d+$/ ) {
310 push @where, "log._date <= $end";
318 if ( $params->{'object'} and $params->{'object'}->isa('FS::Record') ) {
319 my $table = $params->{'object'}->table;
320 my $pkey = dbdef->table($table)->primary_key;
321 my $tablenum = $params->{'object'}->get($pkey);
322 if ( $table and $tablenum ) {
323 push @where, "log.tablename = '$table'", "log.tablenum = $tablenum";
325 } elsif ( $params->{'tablename'} =~ /^(\w+)$/ ) {
327 if ( $params->{'tablenum'} =~ /^(\d+)$/ ) {
328 push @where, "log.tablename = '$table'", "log.tablenum = $1";
336 if ( $params->{'message'} ) { # can be anything, really, so escape it
337 my $quoted_message = dbh->quote('%' . $params->{'message'} . '%');
338 my $op = (driver_name eq 'Pg' ? 'ILIKE' : 'LIKE');
339 push @where, "log.message $op $quoted_message";
346 if ( $params->{'context'} ) {
347 my $quoted = dbh->quote($params->{'context'});
349 "EXISTS(SELECT 1 FROM log_context WHERE log.lognum = log_context.lognum ".
350 "AND log_context.context = $quoted)";
353 # agent virtualization
354 my $access_user = $FS::CurrentUser::CurrentUser;
355 push @where, $access_user->agentnums_sql(
357 viewall_right => 'Configuration',
363 $extra_sql .= 'WHERE ' . join(' AND ', @where) if @where;
364 my $count_query = 'SELECT COUNT(*) FROM log '.$extra_sql;
369 'extra_sql' => $extra_sql,
370 'count_query' => $count_query,
371 'order_by' => 'ORDER BY _date ASC',
372 #addl_from, not needed
382 L<FS::Record>, schema.html from the base documentation.