1 package Text::Tradition::Directory;
7 use Encode qw/ decode_utf8 /;
8 use KiokuDB::GC::Naive;
10 use KiokuDB::TypeMap::Entry::Naive;
11 use Text::Tradition::Error;
14 use KiokuX::User::Util qw(crypt_password);
15 use Text::Tradition::User;
17 extends 'KiokuX::Model';
21 Text::Tradition::Directory - a KiokuDB interface for storing and retrieving traditions
25 use Text::Tradition::Directory;
26 my $d = Text::Tradition::Directory->new(
27 'dsn' => 'dbi:SQLite:mytraditions.db',
28 'extra_args' => { 'create' => 1 },
31 my $tradition = Text::Tradition->new( @args );
32 my $stemma = $tradition->add_stemma( dotfile => $dotfile );
33 $d->save_tradition( $tradition );
35 foreach my $id ( $d->traditions ) {
36 print $d->tradition( $id )->name;
40 my $userstore = Text::Tradition::UserStore->new(dsn => 'dbi:SQLite:foo.db');
41 my $newuser = $userstore->add_user({ username => 'fred',
42 password => 'somepassword' });
44 my $fetchuser = $userstore->find_user({ username => 'fred' });
45 if($fetchuser->check_password('somepassword')) {
46 ## login user or .. whatever
49 my $user = $userstore->deactivate_user({ username => 'fred' });
51 ## shouldnt be able to login etc
56 Text::Tradition::Directory is an interface for storing and retrieving text traditions and all their data, including an associated stemma hypothesis. It is an instantiation of a KiokuDB::Model, storing traditions and associated stemmas by UUID.
62 Constant for the minimum password length when validating passwords,
67 has MIN_PASS_LEN => ( is => 'ro', isa => 'Num', default => sub { 8 } );
73 Returns a Directory object.
77 Returns a hashref mapping of ID => name for all traditions in the directory.
79 =head2 tradition( $id )
81 Returns the Text::Tradition object of the given ID.
83 =head2 save( $tradition )
85 Writes the given tradition to the database, returning its ID.
87 =head2 delete( $tradition )
89 Deletes the given tradition object from the database.
90 WARNING!! Garbage collection does not yet work. Use this sparingly.
97 use_ok 'Text::Tradition::Directory';
99 my $fh = File::Temp->new();
100 my $file = $fh->filename;
102 my $dsn = "dbi:SQLite:dbname=$file";
104 my $t = Text::Tradition->new(
106 'input' => 'Tabular',
107 'file' => 't/data/simple.txt',
111 my $d = Text::Tradition::Directory->new( 'dsn' => $dsn,
112 'extra_args' => { 'create' => 1 } );
113 is( ref $d, 'Text::Tradition::Directory', "Got directory object" );
115 my $scope = $d->new_scope;
116 $uuid = $d->save( $t );
117 ok( $uuid, "Saved test tradition" );
119 my $s = $t->add_stemma( dotfile => 't/data/simple.dot' );
120 ok( $d->save( $t ), "Updated tradition with stemma" );
121 is( $d->tradition( $uuid ), $t, "Correct tradition returned for id" );
122 is( $d->tradition( $uuid )->stemma(0), $s, "...and it has the correct stemma" );
125 } catch( Text::Tradition::Error $e ) {
126 is( $e->ident, 'database error', "Got exception trying to save stemma directly" );
127 like( $e->message, qr/Cannot directly save non-Tradition object/,
128 "Exception has correct message" );
131 my $nt = Text::Tradition->new(
133 'input' => 'CollateX',
134 'file' => 't/data/Collatex-16.xml',
136 is( ref( $nt ), 'Text::Tradition', "Made new tradition" );
139 my $f = Text::Tradition::Directory->new( 'dsn' => $dsn );
140 my $scope = $f->new_scope;
141 is( scalar $f->traditionlist, 1, "Directory index has our tradition" );
142 my $nuuid = $f->save( $nt );
143 ok( $nuuid, "Stored second tradition" );
144 my @tlist = $f->traditionlist;
145 is( scalar @tlist, 2, "Directory index has both traditions" );
146 my $tf = $f->tradition( $uuid );
147 my( $tlobj ) = grep { $_->{'id'} eq $uuid } @tlist;
148 is( $tlobj->{'name'}, $tf->name, "Directory index has correct tradition name" );
149 is( $tf->name, $t->name, "Retrieved the tradition from a new directory" );
150 my $sid = $f->object_to_id( $tf->stemma(0) );
152 $f->tradition( $sid );
153 } catch( Text::Tradition::Error $e ) {
154 is( $e->ident, 'database error', "Got exception trying to fetch stemma directly" );
155 like( $e->message, qr/not a Text::Tradition/, "Exception has correct message" );
159 } catch( Text::Tradition::Error $e ) {
160 is( $e->ident, 'database error', "Got exception trying to delete stemma directly" );
161 like( $e->message, qr/Cannot directly delete non-Tradition object/,
162 "Exception has correct message" );
166 ok( !$f->exists( $uuid ), "Object is deleted from DB" );
167 ok( !$f->exists( $sid ), "Object stemma also deleted from DB" );
168 is( scalar $f->traditionlist, 1, "Object is deleted from index" );
172 my $g = Text::Tradition::Directory->new( 'dsn' => $dsn );
173 my $scope = $g->new_scope;
174 is( scalar $g->traditionlist, 1, "Now one object in new directory index" );
175 my $ntobj = $g->tradition( 'CX' );
176 my @w1 = sort { $a->sigil cmp $b->sigil } $ntobj->witnesses;
177 my @w2 = sort{ $a->sigil cmp $b->sigil } $nt->witnesses;
178 is_deeply( \@w1, \@w2, "Looked up remaining tradition by name" );
187 isa => 'KiokuDB::TypeMap',
189 KiokuDB::TypeMap->new(
191 "Graph" => KiokuDB::TypeMap::Entry::Naive->new,
192 "Graph::AdjacencyMap" => KiokuDB::TypeMap::Entry::Naive->new,
198 # Push some columns into the extra_args
199 around BUILDARGS => sub {
208 if( $args->{'dsn'} =~ /^dbi/ ) { # We're using Backend::DBI
209 my @column_args = ( 'columns',
210 [ 'name' => { 'data_type' => 'varchar', 'is_nullable' => 1 } ] );
211 my $ea = $args->{'extra_args'};
212 if( ref( $ea ) eq 'ARRAY' ) {
213 push( @$ea, @column_args );
214 } elsif( ref( $ea ) eq 'HASH' ) {
215 $ea = { %$ea, @column_args };
217 $ea = { @column_args };
219 $args->{'extra_args'} = $ea;
221 return $class->$orig( $args );
224 before [ qw/ store update insert delete / ] => sub {
227 foreach my $obj ( @_ ) {
228 # if( ref( $obj ) && ref( $obj ) ne 'Text::Tradition' ) {
230 if( ref( $obj ) && ref( $obj ) ne 'Text::Tradition'
231 && ref ($obj) ne 'Text::Tradition::User' ) {
232 # Is it an id => Tradition hash?
233 if( ref( $obj ) eq 'HASH' && keys( %$obj ) == 1 ) {
234 my( $k ) = keys %$obj;
235 next if ref( $obj->{$k} ) eq 'Text::Tradition';
237 push( @nontrad, $obj );
241 throw( "Cannot directly save non-Tradition object of type "
242 . ref( $nontrad[0] ) );
246 # TODO Garbage collection doesn't work. Suck it up and live with the
248 # after delete => sub {
250 # my $gc = KiokuDB::GC::Naive->new( backend => $self->directory->backend );
251 # $self->directory->backend->delete( $gc->garbage->members );
256 return $self->store( @_ );
260 my( $self, $id ) = @_;
261 my $obj = $self->lookup( $id );
263 # Try looking up by name.
264 foreach my $item ( $self->traditionlist ) {
265 if( $item->{'name'} eq $id ) {
266 $obj = $self->lookup( $item->{'id'} );
271 if( $obj && ref( $obj ) ne 'Text::Tradition' ) {
272 throw( "Retrieved object is a " . ref( $obj ) . ", not a Text::Tradition" );
277 sub user_traditionlist {
278 my ($self, $user) = @_;
282 ## We have a user object already, so just fetch its traditions and use tose
283 foreach my $t (@{ $user->traditions }) {
284 push( @tlist, { 'id' => $self->object_to_id( $t ),
285 'name' => $t->name } );
288 } elsif($user ne 'public') {
289 die "Passed neither a user object nor 'public' to user_traditionlist";
292 ## Search for all traditions which allow public viewing
294 # $self->search({ public => 1 });
296 ## For now, just fetch all
297 ## (could use all_objects or grep down there?)
298 return $self->traditionlist();
305 return $self->user_traditionlist($user) if($user);
308 # If we are using DBI, we can do it the easy way; if not, the hard way.
309 # Easy way still involves making a separate DBI connection. Ew.
310 if( $self->dsn =~ /^dbi:(\w+):/ ) {
312 my @connection = @{$self->directory->backend->connect_info};
313 # Get rid of KiokuDB-specific arg
314 pop @connection if scalar @connection > 4;
315 $connection[3]->{'sqlite_unicode'} = 1 if $dbtype eq 'SQLite';
316 $connection[3]->{'pg_enable_utf8'} = 1 if $dbtype eq 'Pg';
317 my $dbh = DBI->connect( @connection );
318 my $q = $dbh->prepare( 'SELECT id, name from entries WHERE class = "Text::Tradition"' );
320 while( my @row = $q->fetchrow_array ) {
321 my( $id, $name ) = @row;
322 # Horrible horrible hack
323 $name = decode_utf8( $name ) if $dbtype eq 'mysql';
324 push( @tlist, { 'id' => $row[0], 'name' => $row[1] } );
327 $self->scan( sub { my $o = shift;
328 push( @tlist, { 'id' => $self->object_to_id( $o ),
329 'name' => $o->name } ) } );
335 Text::Tradition::Error->throw(
336 'ident' => 'database error',
342 # has 'directory' => (
344 # isa => 'KiokuX::Model',
348 ## TODO: Some of these methods should probably optionally take $user objects
349 ## instead of hashrefs.
351 ## It also occurs to me that all these methods don't need to be named
352 ## XX_user, but leaving that way for now incase we merge this code
353 ## into ::Directory for one-store.
355 ## To die or not to die, on error, this is the question.
359 Takes a hashref of C<username>, C<password>.
361 Create a new user object, store in the KiokuDB backend, and return it.
366 my ($self, $userinfo) = @_;
367 my $username = $userinfo->{url} || $userinfo->{username};
368 my $password = $userinfo->{password};
370 return unless ($username =~ /^https?:/
371 || ($username && $self->validate_password($password))) ;
373 my $user = Text::Tradition::User->new(
375 password => ($password ? crypt_password($password) : ''),
378 $self->store($user->kiokudb_object_id, $user);
385 return $self->add_user(@_);
390 Takes a hashref of C<username>, optionally C<openid_identifier>.
392 Fetches the user object for the given username and returns it.
397 my ($self, $userinfo) = @_;
399 # 'display' => 'castaway.myopenid.com',
400 # 'url' => 'http://castaway.myopenid.com/',
401 my $username = $userinfo->{url} || $userinfo->{username};
403 return $self->lookup(Text::Tradition::User->id_for_user($username));
409 Takes a hashref of C<username> and C<password> (same as add_user).
411 Retrieves the user, and updates it with the new information. Username
412 changing is not currently supported.
414 Returns the updated user object, or undef if not found.
419 my ($self, $userinfo) = @_;
420 my $username = $userinfo->{username};
421 my $password = $userinfo->{password};
423 return unless $username && $self->validate_password($password);
425 my $user = $self->find_user({ username => $username });
428 $user->password(crypt_password($password));
430 $self->update($user);
435 =head2 deactivate_user
437 Takes a hashref of C<username>.
439 Sets the users C<active> flag to false (0), and sets all traditions
440 assigned to them to non-public, updates the storage and returns the
443 Returns undef if user not found.
447 sub deactivate_user {
448 my ($self, $userinfo) = @_;
449 my $username = $userinfo->{username};
451 return if !$username;
453 my $user = $self->find_user({ username => $username });
457 foreach my $tradition (@{ $user->traditions }) {
458 ## Not implemented yet
459 # $tradition->public(0);
462 ## Should we be using Text::Tradition::Directory also?
463 $self->update(@{ $user->traditions });
465 $self->update($user);
470 =head2 reactivate_user
472 Takes a hashref of C<username>.
474 Returns the user object if already activated. Activates (sets the
475 active flag to true (1)), updates the storage and returns the user.
477 Returns undef if the user is not found.
481 sub reactivate_user {
482 my ($self, $userinfo) = @_;
483 my $username = $userinfo->{username};
485 return if !$username;
487 my $user = $self->find_user({ username => $username });
490 return $user if $user->active;
493 $self->update($user);
500 CAUTION: Deletes actual data!
502 Takes a hashref of C<username>.
504 Returns undef if the user doesn't exist.
506 Removes the user from the store and returns 1.
511 my ($self, $userinfo) = @_;
512 my $username = $userinfo->{username};
514 return if !$username;
516 my $user = $self->find_user({ username => $username });
519 ## Should we be using Text::Tradition::Directory for this bit?
520 $self->delete( @{ $user->traditions });
523 $self->delete($user);
528 =head2 validate_password
530 Takes a password string. Returns true if it is longer than
531 L</MIN_PASS_LEN>, false otherwise.
533 Used internally by L</add_user>.
537 sub validate_password {
538 my ($self, $password) = @_;
540 return if !$password;
541 return if length($password) < $self->MIN_PASS_LEN;
550 This package is free software and is provided "as is" without express
551 or implied warranty. You can redistribute it and/or modify it under
552 the same terms as Perl itself.
556 Tara L Andrews E<lt>aurum@cpan.orgE<gt>