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