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