lib/DBIx/Class/Schema/Journal.pm

   1 package DBIx::Class::Schema::Journal;
   2
   3 use base qw/DBIx::Class/;
   4
   5 use Scalar::Util 'blessed';
   6 use DBIx::Class::Schema::Journal::DB;
   7
   8 __PACKAGE__->mk_classdata('journal_storage_type');
   9 __PACKAGE__->mk_classdata('journal_connection');
  10 __PACKAGE__->mk_classdata('journal_no_automatic_deploy');
  11 __PACKAGE__->mk_classdata('journal_sources'); ## [ source names ]
  12 __PACKAGE__->mk_classdata('journal_user'); ## [ class, field for user id ]
  13 __PACKAGE__->mk_classdata('_journal_schema'); ## schema object for journal
  14 __PACKAGE__->mk_classdata('_journal_internal_sources'); # the sources used to journal journal_sources
  15
  16 our $VERSION = '0.01';
  17
  18 use strict;
  19 use warnings;
  20
  21 # sub throw_exception
  22 # {
  23 # }
  24
  25 # sub exception_action
  26 # {
  27 #     my $self = shift;
  28 # #    print STDERR Carp::longmess;
  29
  30 #     $self->next::method(@_);
  31 # }
  32
  33 # sub load_classes
  34 # {
  35 #     my $class = shift;
  36
  37
  38 #     $class->next::method(@_);
  39
  40 # }
  41
  42 sub connection
  43 {
  44     my $self = shift;
  45     my $schema = $self->next::method(@_);
  46
  47 #   print STDERR join(":", $self->sources), "\n";
  48
  49     my $journal_schema;
  50     if(!defined($self->journal_connection))
  51     {
  52         ## If no connection, use the same schema/storage etc as the user
  53         DBIx::Class::Componentised->inject_base(ref $self, 'DBIx::Class::Schema::Journal::DB');
  54           $journal_schema = $self;
  55     }
  56     else
  57     {
  58         $journal_schema = DBIx::Class::Schema::Journal::DB->connect(@{ $self->journal_connection });
  59         if($self->journal_storage_type)
  60         {
  61             $journal_schema->storage_type($self->journal_storage_type);
  62         }
  63     }
  64
  65     ## get our own private version of the journaling sources
  66    $self->_journal_schema($journal_schema->compose_namespace(blessed($self) . '::Journal'));
  67
  68     ## Create auditlog+history per table
  69     my %j_sources = map { $_ => 1 } $self->journal_sources
  70                                       ? @{$self->journal_sources}
  71                                       : $self->sources;
  72
  73     my @journal_sources = $journal_schema->sources; # not sources to journal, but sources used by the journal internally
  74
  75     foreach my $s_name ($self->sources)
  76     {
  77         next unless($j_sources{$s_name});
  78         push @journal_sources, $self->create_journal_for($s_name);
  79         $self->class($s_name)->load_components('Journal');
  80 #        print STDERR "$s_name :", $self->class($s_name), "\n";
  81     }
  82
  83     $self->_journal_internal_sources(\@journal_sources);
  84
  85     $self->journal_schema_deploy()
  86         unless $self->journal_no_automatic_deploy;
  87
  88     ## Set up relationship between changeset->user_id and this schema's user
  89     if(!@{$self->journal_user || []})
  90     {
  91         warn "No Journal User set!";
  92         return $schema;
  93     }
  94
  95     $self->_journal_schema->class('ChangeSet')->belongs_to('user', @{$self->journal_user});
  96     $self->_journal_schema->storage->disconnect();
  97
  98     return $schema;
  99 }
 100
 101 sub journal_schema_deploy
 102 {
 103     my ( $self, $sqlt_args, @args ) = @_;
 104
 105     $sqlt_args ||= {};
 106     $sqlt_args->{sources} = $self->_journal_internal_sources
 107         unless exists $sqlt_args->{sources};
 108
 109     $self->_journal_schema->deploy( $sqlt_args, @args );
 110 }
 111
 112 sub get_audit_log_class_name
 113 {
 114     my ($self, $sourcename) = @_;
 115
 116     return blessed($self->_journal_schema) . "::${sourcename}AuditLog";
 117 }
 118
 119 sub get_audit_history_class_name
 120 {
 121     my ($self, $sourcename) = @_;
 122
 123     return blessed($self->_journal_schema) . "::${sourcename}AuditHistory";
 124 }
 125
 126 sub create_journal_for
 127 {
 128     my ($self, $s_name) = @_;
 129
 130     my $source = $self->source($s_name);
 131     my $newclass = $self->get_audit_log_class_name($s_name);
 132     DBIx::Class::Componentised->inject_base($newclass, 'DBIx::Class::Schema::Journal::DB::AuditLog');
 133     $newclass->table(lc($s_name) . "_audit_log");
 134     my $log_source = "${s_name}AuditLog";
 135     $self->_journal_schema->register_class($log_source, $newclass);
 136
 137
 138     my $histclass = $self->get_audit_history_class_name($s_name);
 139     DBIx::Class::Componentised->inject_base($histclass, 'DBIx::Class::Schema::Journal::DB::AuditHistory');
 140     $histclass->table(lc($s_name) . "_audit_history");
 141 #    $histclass->result_source_instance->name(lc($s_name) . "_audit_hisory");
 142     $histclass->add_columns(
 143                             map { $_ => $source->column_info($_) } $source->columns
 144                            );
 145
 146     my $hist_source = "${s_name}AuditHistory";
 147     $self->_journal_schema->register_class($hist_source, $histclass);
 148
 149     return ( $log_source, $hist_source );
 150 }
 151
 152 sub txn_do
 153 {
 154     my ($self, $code) = @_;
 155
 156     ## Create a new changeset, then run $code as a transaction
 157     my $cs = $self->_journal_schema->resultset('ChangeSet');
 158
 159     $self->txn_begin;
 160     my %changesetdata;
 161     if( defined $self->_journal_schema->current_user() )
 162     {
 163         $changesetdata{user_id} = $self->_journal_schema->current_user();
 164     }
 165     if( defined $self->_journal_schema->current_session() )
 166     {
 167         $changesetdata{session_id} = $self->_journal_schema->current_session();
 168     }
 169
 170 #         (
 171 #           $self->_journal_schema->current_user()
 172 #           ? ( user_id => $self->_journal_schema->current_user())
 173 #           : (),
 174 #           $self->_journal_schema->current_session()
 175 #           ? ( session_id => $self->_journal_schema->current_session() )
 176 #           : ()
 177 #         );
 178     if(!%changesetdata)
 179     {
 180         %changesetdata = ( ID => undef );
 181     }
 182     my $changeset = $cs->create({ %changesetdata });
 183     $self->_journal_schema->current_changeset($changeset->ID);
 184
 185     $self->next::method($code);
 186 }
 187
 188 sub changeset_user
 189 {
 190     my ($self, $userid) = @_;
 191
 192     return $self->_journal_schema->current_user() if(@_ == 1);
 193
 194     $self->_journal_schema->current_user($userid);
 195 }
 196
 197 sub changeset_session
 198 {
 199     my ($self, $sessionid) = @_;
 200
 201     return $self->_journal_schema->current_session() if(@_ == 1);
 202
 203     $self->_journal_schema->current_session($sessionid);
 204 }
 205
 206
 207 1;