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