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