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