1 package DBIx::Class::Schema::Journal;
3 use base qw/DBIx::Class/;
5 use Scalar::Util 'blessed';
6 use DBIx::Class::Schema::Journal::DB;
7 use Class::C3::Componentised ();
9 __PACKAGE__->mk_classdata('journal_storage_type');
10 __PACKAGE__->mk_classdata('journal_connection');
11 __PACKAGE__->mk_classdata('journal_deploy_on_connect');
12 __PACKAGE__->mk_classdata('journal_sources'); ## [ source names ]
13 __PACKAGE__->mk_classdata('journal_user'); ## [ class, field for user id ]
14 __PACKAGE__->mk_classdata('journal_copy_sources');
15 __PACKAGE__->mk_classdata('__journal_schema_prototype');
16 __PACKAGE__->mk_classdata('_journal_schema'); ## schema object for journal
17 __PACKAGE__->mk_classdata('journal_component');
18 __PACKAGE__->mk_classdata('journal_components');
19 __PACKAGE__->mk_classdata('journal_nested_changesets');
20 __PACKAGE__->mk_classdata('journal_prefix');
26 sub _journal_schema_prototype {
28 if (my $proto = $self->__journal_schema_prototype) {
31 my $c = blessed($self)||$self;
32 my $journal_schema_class = "${c}::_JOURNAL";
33 Class::C3::Componentised->inject_base($journal_schema_class, 'DBIx::Class::Schema::Journal::DB');
34 $journal_schema_class->load_components($self->journal_components)
35 if $self->journal_components;
36 my $proto = $self->__journal_schema_prototype (
37 $journal_schema_class->compose_namespace( $c.'::Journal')
41 my $comp = $self->journal_component || "Journal";
43 my $prefix = $self->journal_prefix || '';
44 foreach my $audit (qw(ChangeSet ChangeLog)) {
45 my $class = blessed($proto) . "::$audit";
47 Class::C3::Componentised->inject_base($class, "DBIx::Class::Schema::Journal::DB::$audit");
49 $class->journal_define_table(blessed($proto), $prefix);
51 $proto->register_class($audit, $class);
53 $self->register_class($audit, $class)
54 if $self->journal_copy_sources;
57 ## Create auditlog+history per table
58 my %j_sources = map { $_ => 1 } $self->journal_sources
59 ? @{$self->journal_sources}
62 foreach my $s_name ($self->sources) {
63 next unless($j_sources{$s_name});
64 $self->create_journal_for($s_name => $proto);
65 $self->class($s_name)->load_components($comp);
72 my $schema = $self->next::method(@_);
74 my $journal_schema = (ref $self||$self)->_journal_schema_prototype->clone;
76 if($self->journal_connection) {
77 $journal_schema->storage_type($self->journal_storage_type)
78 if $self->journal_storage_type;
79 $journal_schema->connection(@{ $self->journal_connection });
81 $journal_schema->storage( $schema->storage );
84 $self->_journal_schema($journal_schema);
87 if ( $self->journal_nested_changesets ) {
88 $self->_journal_schema->nested_changesets(1);
89 die 'FIXME nested changeset schema not yet supported... add parent_id to ChangeSet here';
92 $self->journal_schema_deploy()
93 if $self->journal_deploy_on_connect;
95 ## Set up relationship between changeset->user_id and this schema's user
96 if(!@{$self->journal_user || []}) {
97 #warn "No Journal User set!"; # no need to warn, user_id is useful even without a rel
101 $self->_journal_schema->class('ChangeSet')->belongs_to('user', @{$self->journal_user});
102 $self->_journal_schema->storage->disconnect();
110 $self->next::method(@_);
112 $self->journal_schema_deploy(@_);
115 sub journal_schema_deploy {
118 $self->_journal_schema->deploy(@_);
121 sub create_journal_for {
122 my ($self, $s_name, $journal_schema) = @_;
124 my $source = $self->source($s_name);
126 foreach my $audit (qw(AuditLog AuditHistory)) {
127 my $audit_source = $s_name.$audit;
128 my $class = blessed($journal_schema) . "::$audit_source";
130 Class::C3::Componentised->inject_base($class, "DBIx::Class::Schema::Journal::DB::$audit");
132 $class->journal_define_table($source, blessed($journal_schema));
134 $journal_schema->register_class($audit_source, $class);
136 $self->register_class($audit_source, $class)
137 if $self->journal_copy_sources;
141 # XXX FIXME deploy is not idempotent :-(
142 sub bootstrap_journal {
144 $self->journal_schema_deploy;
145 $self->prepopulate_journal;
148 # copy data from original schema sources into the journal as inserts in one
149 # changeset, so that later deletes will not fail to be journalled.
150 sub prepopulate_journal {
154 # woah, looks like prepopulate has already run?
155 return if $schema->_journal_schema->resultset('ChangeSet')->count != 0;
157 # using our own overridden txn_do (see below) will create a changeset
158 $schema->txn_do( sub {
159 my %j_sources = map { $_ => 1 } $self->journal_sources
160 ? @{$self->journal_sources}
163 my $j_schema = $self->_journal_schema;
164 my $changelog_rs = $j_schema->resultset('ChangeLog');
165 my $chs_id = $j_schema->current_changeset;
167 foreach my $s_name ($self->sources) {
168 next unless $j_sources{$s_name};
170 my $from_rs = $schema->resultset($s_name);
171 my ($pk) = $from_rs->result_source->primary_columns;
172 $from_rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
174 my $to_rs = $j_schema->resultset("${s_name}AuditHistory");
175 my $log_rs = $j_schema->resultset("${s_name}AuditLog");
179 my @x = $from_rs->search(undef, {
184 # get some number of change log IDs to be generated for this page
185 my @log_ids = map { $_->id }
186 $changelog_rs->populate([
187 map {{ changeset_id => $chs_id }} (0 .. $#x)
190 # create the audit log entries for the rows in this page
192 map {{ create_id => $log_ids[$_], id => $x[$_]->{$pk} }} (0 .. $#x)
195 # now populate the audit history
199 audit_change_id => $log_ids[$_],
208 my ($self, $user_code, @args) = @_;
210 my $jschema = $self->_journal_schema;
212 my $code = $user_code;
214 my $current_changeset = $jschema->_current_changeset;
215 if ( !$current_changeset || $self->journal_nested_changesets ) {
216 my $current_changeset_ref = $jschema->_current_changeset_container;
218 unless ( $current_changeset_ref ) {
219 # this is a hash because scalar refs can't be localized
220 $current_changeset_ref = { };
221 $jschema->_current_changeset_container($current_changeset_ref);
224 # wrap the thunk with a new changeset creation
226 my $changeset = $jschema->journal_create_changeset( parent_id => $current_changeset );
227 local $current_changeset_ref->{changeset} = $changeset->id;
233 if ( $jschema->storage != $self->storage ) {
234 my $inner_code = $code;
235 $code = sub { $jschema->txn_do($inner_code, @_) };
238 return $self->next::method($code, @args);
242 my ($self, $userid) = @_;
244 return $self->_journal_schema->current_user()
247 $self->_journal_schema->current_user($userid);
250 sub changeset_session {
251 my ($self, $sessionid) = @_;
253 return $self->_journal_schema->current_session()
256 $self->_journal_schema->current_session($sessionid);