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 use Class::C3::Componentised ();
   8
   9 __PACKAGE__->mk_classdata('journal_storage_type');
  10 __PACKAGE__->mk_classdata('journal_connection');
  11 __PACKAGE__->mk_classdata('journal_deploy_on_connect');
  12 __PACKAGE__->mk_classdata('journal_sources'); ## [ source names ]
  13 __PACKAGE__->mk_classdata('journal_user'); ## [ class, field for user id ]
  14 __PACKAGE__->mk_classdata('journal_copy_sources');
  15 __PACKAGE__->mk_classdata('__journal_schema_prototype');
  16 __PACKAGE__->mk_classdata('_journal_schema'); ## schema object for journal
  17 __PACKAGE__->mk_classdata('journal_component');
  18 __PACKAGE__->mk_classdata('journal_nested_changesets');
  19
  20 use strict;
  21 use warnings;
  22
  23
  24 sub _journal_schema_prototype
  25 {
  26     my $self = shift;
  27     if (my $proto = $self->__journal_schema_prototype)
  28     {
  29           return $proto;
  30     }
  31     my $proto = $self->__journal_schema_prototype
  32     (
  33         DBIx::Class::Schema::Journal::DB->compose_namespace
  34         (
  35             (blessed($self)||$self) . '::Journal'
  36         )
  37     );
  38     my $comp = $self->journal_component || "Journal";
  39
  40     ## Create auditlog+history per table
  41     my %j_sources = map { $_ => 1 } $self->journal_sources
  42                                       ? @{$self->journal_sources}
  43                                       : $self->sources;
  44
  45     foreach my $s_name ($self->sources)
  46     {
  47         next unless($j_sources{$s_name});
  48         $self->create_journal_for($s_name => $proto);
  49         $self->class($s_name)->load_components($comp);
  50     }
  51     return $proto;
  52 }
  53
  54 sub connection
  55 {
  56     my $self = shift;
  57     my $schema = $self->next::method(@_);
  58
  59     my $journal_schema = (ref $self||$self)->_journal_schema_prototype->clone;
  60
  61     if($self->journal_connection)
  62     {
  63         if($self->journal_storage_type)
  64         {
  65             $journal_schema->storage_type($self->journal_storage_type);
  66         }
  67         $journal_schema->connection(@{ $self->journal_connection });
  68     } else {
  69         $journal_schema->storage( $schema->storage );
  70     }
  71
  72     $self->_journal_schema($journal_schema);
  73
  74
  75     if ( $self->journal_nested_changesets ) {
  76         $self->_journal_schema->nested_changesets(1);
  77         die "FIXME nested changeset schema not yet supported... add parent_id to ChangeSet here";
  78     }
  79
  80     $self->journal_schema_deploy()
  81         if $self->journal_deploy_on_connect;
  82
  83     ## Set up relationship between changeset->user_id and this schema's user
  84     if(!@{$self->journal_user || []})
  85     {
  86         #warn "No Journal User set!"; # no need to warn, user_id is useful even without a rel
  87         return $schema;
  88     }
  89
  90     $self->_journal_schema->class('ChangeSet')->belongs_to('user', @{$self->journal_user});
  91     $self->_journal_schema->storage->disconnect();
  92
  93     return $schema;
  94 }
  95
  96 sub deploy
  97 {
  98     my ( $self, $sqlt_args, @args ) = @_;
  99
 100     $self->next::method($sqlt_args, @args);
 101
 102     $self->journal_schema_deploy($sqlt_args, @args);
 103 }
 104
 105 sub journal_schema_deploy
 106 {
 107     my ( $self, $sqlt_args, @args ) = @_;
 108
 109     $self->_journal_schema->deploy( $sqlt_args, @args );
 110 }
 111
 112 sub create_journal_for
 113 {
 114     my ($self, $s_name, $journal_schema) = @_;
 115
 116     my $source = $self->source($s_name);
 117
 118     foreach my $audit (qw(AuditLog AuditHistory)) {
 119         my $audit_source = $s_name.$audit;
 120         my $class = blessed($journal_schema) . "::$audit_source";
 121
 122                   Class::C3::Componentised->inject_base($class, "DBIx::Class::Schema::Journal::DB::$audit");
 123
 124         $class->journal_define_table($source);
 125
 126         $journal_schema->register_class($audit_source, $class);
 127
 128         if ($self->journal_copy_sources)
 129         {
 130             $self->register_class($audit_source, $class);
 131         }
 132     }
 133 }
 134
 135 sub txn_do
 136 {
 137     my ($self, $user_code, @args) = @_;
 138
 139     my $jschema = $self->_journal_schema;
 140
 141     my $code = $user_code;
 142
 143     my $current_changeset = $jschema->_current_changeset;
 144     if ( !$current_changeset || $self->journal_nested_changesets )
 145     {
 146         my $current_changeset_ref = $jschema->_current_changeset_container;
 147
 148         unless ( $current_changeset_ref ) {
 149             # this is a hash because scalar refs can't be localized
 150             $current_changeset_ref = { };
 151             $jschema->_current_changeset_container($current_changeset_ref);
 152         }
 153
 154         # wrap the thunk with a new changeset creation
 155         $code = sub {
 156             my $changeset = $jschema->journal_create_changeset( parent_id => $current_changeset );
 157             local $current_changeset_ref->{changeset} = $changeset->id;
 158             $user_code->(@_);
 159         };
 160
 161     }
 162
 163     if ( $jschema->storage != $self->storage ) {
 164         my $inner_code = $code;
 165         $code = sub { $jschema->txn_do($inner_code, @_) };
 166     }
 167
 168     return $self->next::method($code, @args);
 169 }
 170
 171 sub changeset_user
 172 {
 173     my ($self, $userid) = @_;
 174
 175     return $self->_journal_schema->current_user() if(@_ == 1);
 176
 177     $self->_journal_schema->current_user($userid);
 178 }
 179
 180 sub changeset_session
 181 {
 182     my ($self, $sessionid) = @_;
 183
 184     return $self->_journal_schema->current_session() if(@_ == 1);
 185
 186     $self->_journal_schema->current_session($sessionid);
 187 }
 188
 189
 190 1;