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_deploy_on_connect');
  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_nested_changesets');
  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 = DBIx::Class::Schema::Journal::DB->compose_namespace(blessed($self) . '::Journal');
  50
  51     if($self->journal_connection)
  52     {
  53         if($self->journal_storage_type)
  54         {
  55             $journal_schema->storage_type($self->journal_storage_type);
  56         }
  57         $journal_schema->connection(@{ $self->journal_connection });
  58     } else {
  59         $journal_schema->storage( $schema->storage );
  60     }
  61
  62     $self->_journal_schema($journal_schema);
  63
  64
  65     ## Create auditlog+history per table
  66     my %j_sources = map { $_ => 1 } $self->journal_sources
  67                                       ? @{$self->journal_sources}
  68                                       : $self->sources;
  69
  70     foreach my $s_name ($self->sources)
  71     {
  72         next unless($j_sources{$s_name});
  73         $self->create_journal_for($s_name);
  74         $self->class($s_name)->load_components('Journal');
  75 #        print STDERR "$s_name :", $self->class($s_name), "\n";
  76     }
  77
  78     if ( $self->journal_nested_changesets ) {
  79         $self->_journal_schema->nested_changesets(1);
  80         die "FIXME nested changeset schema not yet supported... add parent_id to ChangeSet here";
  81     }
  82
  83     $self->journal_schema_deploy()
  84         if $self->journal_deploy_on_connect;
  85
  86     ## Set up relationship between changeset->user_id and this schema's user
  87     if(!@{$self->journal_user || []})
  88     {
  89         #warn "No Journal User set!"; # no need to warn, user_id is useful even without a rel
  90         return $schema;
  91     }
  92
  93     $self->_journal_schema->class('ChangeSet')->belongs_to('user', @{$self->journal_user});
  94     $self->_journal_schema->storage->disconnect();
  95
  96     return $schema;
  97 }
  98
  99 sub deploy
 100 {
 101     my ( $self, $sqlt_args, @args ) = @_;
 102
 103     $self->next::method($sqlt_args, @args);
 104
 105     $self->journal_schema_deploy($sqlt_args, @args);
 106 }
 107
 108 sub journal_schema_deploy
 109 {
 110     my ( $self, $sqlt_args, @args ) = @_;
 111
 112     $self->_journal_schema->deploy( $sqlt_args, @args );
 113 }
 114
 115 sub get_audit_log_class_name
 116 {
 117     my ($self, $sourcename) = @_;
 118
 119     return blessed($self->_journal_schema) . "::${sourcename}AuditLog";
 120 }
 121
 122 sub get_audit_history_class_name
 123 {
 124     my ($self, $sourcename) = @_;
 125
 126     return blessed($self->_journal_schema) . "::${sourcename}AuditHistory";
 127 }
 128
 129 sub create_journal_for
 130 {
 131     my ($self, $s_name) = @_;
 132
 133     my $source = $self->source($s_name);
 134     my $newclass = $self->get_audit_log_class_name($s_name);
 135     DBIx::Class::Componentised->inject_base($newclass, 'DBIx::Class::Schema::Journal::DB::AuditLog');
 136     $newclass->table(lc($s_name) . "_audit_log");
 137     my $log_source = "${s_name}AuditLog";
 138     $self->_journal_schema->register_class($log_source, $newclass);
 139
 140
 141     my $histclass = $self->get_audit_history_class_name($s_name);
 142     DBIx::Class::Componentised->inject_base($histclass, 'DBIx::Class::Schema::Journal::DB::AuditHistory');
 143     $histclass->table(lc($s_name) . "_audit_history");
 144 #    $histclass->result_source_instance->name(lc($s_name) . "_audit_hisory");
 145
 146     foreach my $column ( $source->columns ) {
 147         my $info = $source->column_info($column);
 148
 149         my %hist_info = %$info;
 150
 151         delete $hist_info{$_} for qw(
 152             is_foreign_key
 153             is_primary_key
 154             is_auto_increment
 155             default_value
 156         );
 157
 158         $hist_info{is_nullable} = 1;
 159
 160         $histclass->add_column($column => \%hist_info);
 161     }
 162
 163     my $hist_source = "${s_name}AuditHistory";
 164     $self->_journal_schema->register_class($hist_source, $histclass);
 165
 166     return ( $log_source, $hist_source );
 167 }
 168
 169 sub txn_do
 170 {
 171     my ($self, $user_code, @args) = @_;
 172
 173     my $jschema = $self->_journal_schema;
 174
 175     my $code = $user_code;
 176
 177     my $current_changeset = $jschema->_current_changeset;
 178     if ( !$current_changeset || $self->journal_nested_changesets )
 179     {
 180         my $current_changeset_ref = $jschema->_current_changeset_container;
 181
 182         unless ( $current_changeset_ref ) {
 183             # this is a hash because scalar refs can't be localized
 184             $current_changeset_ref = { };
 185             $jschema->_current_changeset_container($current_changeset_ref);
 186         }
 187
 188         # wrap the thunk with a new changeset creation
 189         $code = sub {
 190             my $changeset = $jschema->journal_create_changeset( parent_id => $current_changeset );
 191             local $current_changeset_ref->{changeset} = $changeset->id;
 192             $user_code->(@_);
 193         };
 194
 195     }
 196
 197     if ( $jschema->storage != $self->storage ) {
 198         my $inner_code = $code;
 199         $code = sub { $jschema->txn_do($inner_code, @_) };
 200     }
 201
 202     return $self->next::method($code, @args);
 203 }
 204
 205 sub changeset_user
 206 {
 207     my ($self, $userid) = @_;
 208
 209     return $self->_journal_schema->current_user() if(@_ == 1);
 210
 211     $self->_journal_schema->current_user($userid);
 212 }
 213
 214 sub changeset_session
 215 {
 216     my ($self, $sessionid) = @_;
 217
 218     return $self->_journal_schema->current_session() if(@_ == 1);
 219
 220     $self->_journal_schema->current_session($sessionid);
 221 }
 222
 223
 224 1;